From 9ea9ffd0aa6a9c9b8a4c5fb5bd0e293f1ffa6366 Mon Sep 17 00:00:00 2001
From: yager2 <yager2@illinois.edu>
Date: Sat, 22 Sep 2018 10:41:59 -0500
Subject: [PATCH] Update README.md
---
README.md | 29 ++++++++++++++---------------
1 file changed, 14 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
index 011d4f8..12715b8 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
## What is this project?
**Project title:** Taffic Patterns in New York City
-**Team members:** Richard Sowers, Derek Yager, Vaibhav Karve, Marzieh Abolhelm.
+**Team members:** Richard Sowers, Derrek Yager, Vaibhav Karve, Marzieh Abolhelm.
## What does this code do?
@@ -16,23 +16,22 @@
- System requirements:
- Python3
- Jupyter Notebook
-- Files needed:
- In order to run this code, you will need a copy of the `util` folder and its contents.
- The notebooks at the top level `./` can be run independently of each other.
+- Go to https://databank.illinois.edu/datasets/IDB-4900670 for necessary files and import into DataFiles/:
+ - nodes.csv
+ - links.csv
+ - travel_times_2011.csv
## How is this repository organized?
-- ./ (Home directory: Files listed in order of increasing complexity)
- - NMF.ipynb
- - verifier.ipynb
- - CNMF.ipynb
- - SCNMF.ipynb
- - sparsity.ipynb
-- utils/ (Contains all utilities and class definitions)
- - NonNegProjector.py
- - Objective.py
- - EndChecker.py
- - RandomMagnitude.py
+- ./ (Home directory: DataFiles -> ReadData -> MultiplicativeAlgorithm)
+ - ReadData
+ - Archive
+ - MultiplicativeAlgorithm
+ - DataFiles
+- ReadData/ (Contains ReadData.ipynb for importing data into matrix format)
+- MultiplicativeAlgorithm/ (Contains the meat)
+ - CSNMF.ipynb does most of the work
+
## Importing into Jupyter Notebook
--
GitLab