Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
davidpomerenke committed Sep 1, 2023
1 parent c0ac6be commit 14323ad
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 21 deletions.
25 changes: 4 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,37 +18,20 @@ Protests can have an impact on newspaper coverage, not only by prompting reports

## Structure

├── LICENSE
├── Makefile <- Makefile with commands like `make data` or `make train`
├── README.md <- The top-level README for developers using this project.
├── data
│   ├── external <- Data from third party sources.
│   ├── interim <- Intermediate data that has been transformed.
│   ├── processed <- The final, canonical data sets for modeling.
│   └── raw <- The original, immutable data dump.
├── models <- Trained and serialized models, model predictions, or model summaries
├── notebooks <- Jupyter notebooks.
├── pyproject.toml <- Requirements for installation with [Poetry](https://python-poetry.org/).
├── report <- [Quarto](https://quarto.org/) project with the source for the report.
├── setup.py <- makes project pip installable (pip install -e .) so src can be imported
└── src <- Source code for use in this project.
   ├── __init__.py <- Makes src a Python module
   ├── data <- Scripts to download or generate data
   │   └── make_dataset.py
   ├── features <- Scripts to turn raw data into features for modeling
   │   └── build_features.py
   ├── models <- Scripts to train models and then use trained models to make
│ │ predictions
   │   ├── predict_model.py
   │   └── train_model.py
   └── visualization <- Scripts to create exploratory and results oriented visualizations
   └── visualize.py
   ├── data
   ├── features
   ├── models
   └── visualization

## License

Expand Down
Binary file modified report/figures/graphical-abstract.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 14323ad

Please sign in to comment.