diff --git a/README.md b/README.md index 011d4f89dbc9353489b8a851131a535096a83e24..12715b8ab5e845e3ca93ee5b17d26cfb794382fd 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