This is a template repo for your project to help you organise and document your code better. Please use this structure for your project and document the installation, usage and structure as below.
## Quickstart
# clone project
git clone <project link>
cd <project repo>
# [OPTIONAL] create conda environment
conda create -n <env_name> python=3.11 or ...
conda activate <env_name>
# install requirements
pip install -r pip_requirements.txt
To get the datasets for the analysis, download from http://www.cs.cmu.edu/~ark/personas/ and https://www.kaggle.gicom/datasets/asaniczka/tmdb-movies-dataset-2023-930k-movies.
Tell us how the code is arranged, any explanations goes here.
The directory structure of new project looks like this:
├── data <- Project data files
│
├── src <- Source code
│ ├── data <- Data directory
│ ├── models <- Model directory
│ ├── utils <- Utility directory
│ ├── scripts <- Shell scripts
│
├── tests <- Tests of any kind
│
├── results.ipynb <- a well-structured notebook showing the results
│
├── .gitignore <- List of files ignored by git
├── pip_requirements.txt <- File for installing python dependencies
└── README.md