Skip to content

Commit 07ecc14

Browse files
authored
Update README.md
directory structure
1 parent b7b5fef commit 07ecc14

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,30 @@ Built with ❀️ by a team of graduate students as part of our coursework under
6161
## πŸ“Ž License
6262
feel free to fork, star, and remix with credit!
6363

64+
## πŸ“ Project Structure
65+
PySparkFlicks_MovieRecommender/
66+
β”‚
67+
β”œβ”€β”€ code/ # All PySpark code/scripts
68+
β”‚ β”œβ”€β”€ preprocessing.py
69+
β”‚ β”œβ”€β”€ train_model.py
70+
β”‚ └── utils.py
71+
β”‚
72+
β”œβ”€β”€ notebooks/ # Optional: Jupyter Notebooks (.ipynb)
73+
β”‚ └── movie_recommender.ipynb
74+
β”‚
75+
β”œβ”€β”€ data/ # (optional) Add sample dataset for demo/testing
76+
β”‚ └── sample_ratings.csv
77+
β”‚
78+
β”œβ”€β”€ documentation/ # IEEE paper, diagrams, screenshots
79+
β”‚ β”œβ”€β”€ project_report.pdf
80+
β”‚ └── architecture.png
81+
β”‚
82+
β”œβ”€β”€ .github/
83+
β”‚ └── workflows/
84+
β”‚ └── python-package.yml
85+
β”‚
86+
β”œβ”€β”€ requirements.txt # pip dependencies
87+
β”œβ”€β”€ setup.py # optional, for making this pip installable
88+
β”œβ”€β”€ README.md # landing page πŸ“„
89+
└── LICENSE # add MIT license or similar if open-source
90+

0 commit comments

Comments
Β (0)