diff --git a/README.md b/README.md index 15f9a7ec..b8a9ac4e 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,35 @@ -# SoccerTrack +.. rubric:: SoccerTrack [![Documentation Status](https://readthedocs.org/projects/soccertrack/badge/?version=latest)](https://soccertrack.readthedocs.io/en/latest/?badge=latest) -SoccerTrack is a dataset for tracking soccer players and balls. -Project Organization ------------- +## What is SoccerTrack? - ├── 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. - │ - ├── docs <- A default Sphinx project; see sphinx-doc.org for details - │ - ├── models <- Trained and serialized models, model predictions, or model summaries +SoccerTrack is a dataset and for tracking soccer players and balls. + + +## Project Organization + +This project was based on the [cookiecutter data science template](https://drivendata.github.io/cookiecutter-data-science/), but some folders were removed. Below is a brief overview of the current project structure. + +``` │ - ├── notebooks <- Jupyter notebooks. Naming convention is a number (for ordering), - │ the creator's initials, and a short `-` delimited description, e.g. - │ `1.0-jqp-initial-data-exploration`. + ├── docs <- Sphinx project. │ - ├── references <- Data dictionaries, manuals, and all other explanatory materials. + ├── notebooks <- Jupyter notebooks for example usage. │ - ├── reports <- Generated analysis as HTML, PDF, LaTeX, etc. - │   └── figures <- Generated graphics and figures to be used in reporting + ├── reports <- Generated analysis including references │ - ├── requirements.txt <- The requirements file for reproducing the analysis environment, e.g. - │ generated with `pip freeze > requirements.txt` + ├── soccertrack <- Source code. See API Refence. │ - ├── 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 <- (Only minimum stuff on github). + │   ├── 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. │ - └── tox.ini <- tox file with settings for running tox; see tox.readthedocs.io - + └── models <- Trained model weights (only minimum stuff on github). +``` -------- - -

Project based on the cookiecutter data science project template. #cookiecutterdatascience