|
1 | 1 | # Activity tracker |
2 | 2 |
|
3 | | -## Project Organization |
4 | | - |
5 | | -``` |
6 | | -├── LICENSE <- Open-source license if one is chosen |
7 | | -├── README.md <- The top-level README for developers using this project. |
8 | | -├── data |
9 | | -│ ├── external <- Data from third party sources. |
10 | | -│ ├── interim <- Intermediate data that has been transformed. |
11 | | -│ ├── processed <- The final, canonical data sets for modeling. |
12 | | -│ └── raw <- The original, immutable data dump. |
13 | | -│ |
14 | | -├── docs <- A default mkdocs project; see www.mkdocs.org for details |
15 | | -│ |
16 | | -├── models <- Trained and serialized models, model predictions, or model summaries |
17 | | -│ |
18 | | -├── notebooks <- Jupyter notebooks. Naming convention is a number (for ordering), |
19 | | -│ the creator's initials, and a short `-` delimited description, e.g. |
20 | | -│ `1.0-jqp-initial-data-exploration`. |
21 | | -│ |
22 | | -├── pyproject.toml <- Project configuration file with package metadata for |
23 | | -│ nlp_project_template and configuration for tools like black |
24 | | -│ |
25 | | -├── references <- Data dictionaries, manuals, and all other explanatory materials. |
26 | | -│ |
27 | | -├── reports <- Generated analysis as HTML, PDF, LaTeX, etc. |
28 | | -│ └── figures <- Generated graphics and figures to be used in reporting |
29 | | -│ |
30 | | -├── requirements.txt <- The requirements file for reproducing the analysis environment, e.g. |
31 | | -│ generated with `pip freeze > requirements.txt` |
32 | | -│ |
33 | | -├── .env <- Store environment variables |
34 | | -│ |
35 | | -├── setup.cfg <- Configuration file for flake8 |
36 | | -│ |
37 | | -├── sql <- Store sql queries |
38 | | -│ |
39 | | -├── scratch <- Temporary or experimental code or files |
40 | | -│ |
41 | | -├── setup.cfg <- Configuration file for flake8│ |
42 | | -│ |
43 | | -└── src/nlp_project_template <- Source code for use in this project. |
44 | | - │ |
45 | | - ├── __init__.py <- Makes nlp_project_template a Python module |
46 | | - │ |
47 | | - ├── config.py <- Store useful variables and configuration |
48 | | - │ |
49 | | - ├── dataset.py <- Scripts to download or generate data |
50 | | - │ |
51 | | - ├── features.py <- Code to create features for modeling |
52 | | - │ |
53 | | - ├── modeling |
54 | | - │ ├── __init__.py |
55 | | - │ ├── predict.py <- Code to run model inference with trained models |
56 | | - │ └── train.py <- Code to train models |
57 | | - │ |
58 | | - └── plots.py <- Code to create visualizations |
59 | | -``` |
60 | | - |
61 | | ---- |
| 3 | + |
62 | 4 |
|
63 | 5 | ### Create a virtual environment with: |
64 | 6 |
|
|
0 commit comments