Skip to content

Commit 1c64b68

Browse files
committed
Add data files
1 parent 885795a commit 1c64b68

File tree

126 files changed

+1631
-1417
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

126 files changed

+1631
-1417
lines changed

.gitignore

Lines changed: 0 additions & 89 deletions
This file was deleted.

LICENSE

Lines changed: 0 additions & 1 deletion
This file was deleted.

Makefile

Lines changed: 0 additions & 144 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -1,123 +1 @@
1-
DSFSI Project Starter
2-
==============================
3-
4-
_This documentation is aimed to help provide information that explains what a project is about._
5-
6-
Last updated: August 2023
7-
8-
## Table of contents
9-
10-
1. [Project Description](#project-description)
11-
2. [Project Organization](#project-organization)
12-
3. [Getting Started](#getting-started)
13-
4. [Authors](#authors)
14-
5. [More Information](#more-information)
15-
16-
## Project Description
17-
-----------
18-
19-
A short description of the project.
20-
21-
## Project Organization
22-
------------
23-
24-
├── LICENSE
25-
├── Makefile <- Makefile with commands like `make data` or `make train`
26-
├── README.md <- The top-level README for developers using this project.
27-
├── data
28-
│   ├── external <- Data from third party sources.
29-
│   ├── interim <- Intermediate data that has been transformed.
30-
│   ├── processed <- The final, canonical data sets for modeling.
31-
│   └── raw <- The original, immutable data dump.
32-
33-
├── docs <- A default Sphinx project; see sphinx-doc.org for details
34-
35-
├── models <- Trained and serialized models, model predictions, or model summaries
36-
37-
├── notebooks <- Jupyter notebooks. Naming convention is a number (for ordering),
38-
│ the creator's initials, and a short `-` delimited description, e.g.
39-
│ `1.0-jqp-initial-data-exploration`.
40-
41-
├── references <- Data dictionaries, manuals, and all other explanatory materials.
42-
43-
├── reports <- Generated analysis as HTML, PDF, LaTeX, etc.
44-
│   └── figures <- Generated graphics and figures to be used in reporting
45-
46-
├── requirements.txt <- The requirements file for reproducing the analysis environment, e.g.
47-
│ generated with `pip freeze > requirements.txt`
48-
49-
├── setup.py <- makes project pip installable (pip install -e .) so src can be imported
50-
├── src <- Source code for use in this project.
51-
│   ├── __init__.py <- Makes src a Python module
52-
│ │
53-
│   ├── data <- Scripts to download or generate data
54-
│   │   └── make_dataset.py
55-
│ │
56-
│   ├── features <- Scripts to turn raw data into features for modeling
57-
│   │   └── build_features.py
58-
│ │
59-
│   ├── models <- Scripts to train models and then use trained models to make
60-
│ │ │ predictions
61-
│   │   ├── predict_model.py
62-
│   │   └── train_model.py
63-
│ │
64-
│   └── visualization <- Scripts to create exploratory and results oriented visualizations
65-
│   └── visualize.py
66-
67-
└── tox.ini <- tox file with settings for running tox; see tox.testrun.org
68-
69-
70-
--------
71-
72-
<p><small>Project based on the <a target="_blank" href="https://drivendata.github.io/cookiecutter-data-science/">cookiecutter data science project template</a>. #cookiecutterdatascience</small></p>
73-
74-
## Getting Started
75-
-----------
76-
_This section provides the necessary information for a user to be able to run the code locally._
77-
78-
### Prerequisites
79-
80-
Provide a summary of the list software and the version required to run the code. An example of this is :
81-
82-
- Python 3.11.3
83-
84-
### Installation
85-
86-
Provide the instructions and code necessary to setup the required software environment for the code. An example of this is :
87-
88-
1. Run the setup.py to build the src python package
89-
2. Run the requirements.txt to install all the required libraries, modules, and packages.
90-
91-
```
92-
93-
python setup.py install
94-
pip install -r requirements.txt
95-
96-
```
97-
98-
### Usage
99-
100-
Provide information and code on how to run the code and use the code. This includes instructions and examples of inputs and outputs. An example of this is :
101-
102-
1. To use the code , run the following line:
103-
104-
```
105-
106-
python src/main.py
107-
108-
```
109-
110-
## Authors
111-
-----------
112-
113-
* Written by :
114-
* Contact details :
115-
116-
### Contributions
117-
118-
This is optional and provides information about which and how each of the developers contributed.
119-
120-
## More Information
121-
---------
122-
123-
Provide any relevant informations about the project.
1+
# Data Commons Data

0 commit comments

Comments
 (0)