Spaces:
Runtime error
Runtime error
readme updates
Browse files- README.md +6 -10
- reports/figures/.gitkeep +0 -0
README.md
CHANGED
@@ -23,26 +23,20 @@ Project Organization
|
|
23 |
βΒ Β βββ processed <- The final, canonical data sets for modeling.
|
24 |
βΒ Β βββ raw <- The original, immutable data dump.
|
25 |
β
|
26 |
-
βββ eval.dvc <- The end of the data pipeline - evaluates the trained model on the test dataset.
|
27 |
-
β
|
28 |
βββ models <- Trained and serialized models, model predictions, or model summaries
|
29 |
β
|
30 |
βββ notebooks <- Jupyter notebooks. Naming convention is a number (for ordering),
|
31 |
β the creator's initials, and a short `-` delimited description, e.g.
|
32 |
β `1.0-jqp-initial-data-exploration`.
|
33 |
β
|
34 |
-
βββ process_data.dvc <- Process the raw data and prepare it for training.
|
35 |
-
βββ raw_data.dvc <- Keeps the raw data versioned.
|
36 |
β
|
37 |
βββ references <- Data dictionaries, manuals, and all other explanatory materials.
|
38 |
β
|
39 |
βββ reports <- Generated analysis as HTML, PDF, LaTeX, etc.
|
40 |
-
βΒ Β βββ figures <- Generated graphics and figures to be used in reporting
|
41 |
βΒ Β βββ metrics.txt <- Relevant metrics after evaluating the model.
|
42 |
βΒ Β βββ training_metrics.txt <- Relevant metrics from training the model.
|
43 |
β
|
44 |
-
βββ requirements.txt <- The requirements file for reproducing the analysis environment
|
45 |
-
β generated with `pip freeze > requirements.txt`
|
46 |
β
|
47 |
βββ setup.py <- makes project pip installable (pip install -e .) so src can be imported
|
48 |
βββ src <- Source code for use in this project.
|
@@ -50,17 +44,19 @@ Project Organization
|
|
50 |
β β
|
51 |
βΒ Β βββ data <- Scripts to download or generate data
|
52 |
βΒ Β βΒ Β βββ make_dataset.py
|
|
|
53 |
β β
|
54 |
-
βΒ Β βββ models <- Scripts to train models
|
55 |
-
β β β predictions
|
56 |
βΒ Β βΒ Β βββ predict_model.py
|
57 |
βΒ Β βΒ Β βββ train_model.py
|
|
|
|
|
58 |
β β
|
59 |
βΒ Β βββ visualization <- Scripts to create exploratory and results oriented visualizations
|
60 |
βΒ Β βββ visualize.py
|
61 |
β
|
62 |
βββ tox.ini <- tox file with settings for running tox; see tox.testrun.org
|
63 |
-
βββ
|
64 |
|
65 |
|
66 |
--------
|
|
|
23 |
βΒ Β βββ processed <- The final, canonical data sets for modeling.
|
24 |
βΒ Β βββ raw <- The original, immutable data dump.
|
25 |
β
|
|
|
|
|
26 |
βββ models <- Trained and serialized models, model predictions, or model summaries
|
27 |
β
|
28 |
βββ notebooks <- Jupyter notebooks. Naming convention is a number (for ordering),
|
29 |
β the creator's initials, and a short `-` delimited description, e.g.
|
30 |
β `1.0-jqp-initial-data-exploration`.
|
31 |
β
|
|
|
|
|
32 |
β
|
33 |
βββ references <- Data dictionaries, manuals, and all other explanatory materials.
|
34 |
β
|
35 |
βββ reports <- Generated analysis as HTML, PDF, LaTeX, etc.
|
|
|
36 |
βΒ Β βββ metrics.txt <- Relevant metrics after evaluating the model.
|
37 |
βΒ Β βββ training_metrics.txt <- Relevant metrics from training the model.
|
38 |
β
|
39 |
+
βββ requirements.txt <- The requirements file for reproducing the analysis environment
|
|
|
40 |
β
|
41 |
βββ setup.py <- makes project pip installable (pip install -e .) so src can be imported
|
42 |
βββ src <- Source code for use in this project.
|
|
|
44 |
β β
|
45 |
βΒ Β βββ data <- Scripts to download or generate data
|
46 |
βΒ Β βΒ Β βββ make_dataset.py
|
47 |
+
βΒ Β βΒ Β βββ process_data.py
|
48 |
β β
|
49 |
+
βΒ Β βββ models <- Scripts to train models
|
|
|
50 |
βΒ Β βΒ Β βββ predict_model.py
|
51 |
βΒ Β βΒ Β βββ train_model.py
|
52 |
+
βΒ Β βΒ Β βββ evaluate_model.py
|
53 |
+
βΒ Β βΒ Β βββ model.py
|
54 |
β β
|
55 |
βΒ Β βββ visualization <- Scripts to create exploratory and results oriented visualizations
|
56 |
βΒ Β βββ visualize.py
|
57 |
β
|
58 |
βββ tox.ini <- tox file with settings for running tox; see tox.testrun.org
|
59 |
+
βββ data.dvc <- Traing a model on the processed data.
|
60 |
|
61 |
|
62 |
--------
|
reports/figures/.gitkeep
DELETED
File without changes
|