Laura Cabayol Garcia commited on
Commit
b6e3cca
Β·
1 Parent(s): 86c831d

move readme

Browse files
Files changed (3) hide show
  1. README.md +66 -0
  2. README_GITHUB.md +0 -75
  3. README_HF.md +9 -0
README.md CHANGED
@@ -1,3 +1,66 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  title: PENGUINS CLASSIFIER
2
  emoji: πŸ“ˆ
3
  colorFrom: indigo
@@ -7,3 +70,6 @@ sdk_version: 4.44.0
7
  app_file: app.py
8
  pinned: false
9
  license: apache-2.0
 
 
 
 
1
+ # VitalMetrics
2
+
3
+ <a target="_blank" href="https://cookiecutter-data-science.drivendata.org/">
4
+ <img src="https://img.shields.io/badge/CCDS-Project%20template-328F97?logo=cookiecutter" />
5
+ </a>
6
+
7
+ Repository to Practicing data cleaning, transformation, and analysis techniques. Multi-Class Classification for healthcare prediction.
8
+
9
+ ## Project Organization
10
+
11
+ ```
12
+ β”œβ”€β”€ LICENSE <- Open-source license if one is chosen
13
+ β”œβ”€β”€ Makefile <- Makefile with convenience commands like `make data` or `make train`
14
+ β”œβ”€β”€ README.md <- The top-level README for developers using this project.
15
+ β”œβ”€β”€ data
16
+ β”‚ β”œβ”€β”€ external <- Data from third party sources.
17
+ β”‚ β”œβ”€β”€ interim <- Intermediate data that has been transformed.
18
+ β”‚ β”œβ”€β”€ processed <- The final, canonical data sets for modeling.
19
+ β”‚ └── raw <- The original, immutable data dump.
20
+ β”‚
21
+ β”œβ”€β”€ docs <- A default mkdocs project; see www.mkdocs.org for details
22
+ β”‚
23
+ β”œβ”€β”€ models <- Trained and serialized models, model predictions, or model summaries
24
+ β”‚
25
+ β”œβ”€β”€ notebooks <- Jupyter notebooks. Naming convention is a number (for ordering),
26
+ β”‚ the creator's initials, and a short `-` delimited description, e.g.
27
+ β”‚ `1.0-jqp-initial-data-exploration`.
28
+ β”‚
29
+ β”œβ”€β”€ pyproject.toml <- Project configuration file with package metadata for
30
+ β”‚ VitalMetrics and configuration for tools like black
31
+ β”‚
32
+ β”œβ”€β”€ references <- Data dictionaries, manuals, and all other explanatory materials.
33
+ β”‚
34
+ β”œβ”€β”€ reports <- Generated analysis as HTML, PDF, LaTeX, etc.
35
+ β”‚ └── figures <- Generated graphics and figures to be used in reporting
36
+ β”‚
37
+ β”œβ”€β”€ requirements.txt <- The requirements file for reproducing the analysis environment, e.g.
38
+ β”‚ generated with `pip freeze > requirements.txt`
39
+ β”‚
40
+ β”œβ”€β”€ setup.cfg <- Configuration file for flake8
41
+ β”‚
42
+ └── VitalMetrics <- Source code for use in this project.
43
+ β”‚
44
+ β”œβ”€β”€ __init__.py <- Makes VitalMetrics a Python module
45
+ β”‚
46
+ β”œβ”€β”€ config.py <- Store useful variables and configuration
47
+ β”‚
48
+ β”œβ”€β”€ dataset.py <- Scripts to download or generate data
49
+ β”‚
50
+ β”œβ”€β”€ features.py <- Code to create features for modeling
51
+ β”‚
52
+ β”œβ”€β”€ modeling
53
+ β”‚ β”œβ”€β”€ __init__.py
54
+ β”‚ β”œβ”€β”€ predict.py <- Code to run model inference with trained models
55
+ β”‚ └── train.py <- Code to train models
56
+ β”‚
57
+ └── plots.py <- Code to create visualizations
58
+ |
59
+ |__ classifier.py
60
+ ```
61
+
62
+ --------
63
+ ---
64
  title: PENGUINS CLASSIFIER
65
  emoji: πŸ“ˆ
66
  colorFrom: indigo
 
70
  app_file: app.py
71
  pinned: false
72
  license: apache-2.0
73
+ ---
74
+
75
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
README_GITHUB.md DELETED
@@ -1,75 +0,0 @@
1
- # VitalMetrics
2
-
3
- <a target="_blank" href="https://cookiecutter-data-science.drivendata.org/">
4
- <img src="https://img.shields.io/badge/CCDS-Project%20template-328F97?logo=cookiecutter" />
5
- </a>
6
-
7
- Repository to Practicing data cleaning, transformation, and analysis techniques. Multi-Class Classification for healthcare prediction.
8
-
9
- ## Project Organization
10
-
11
- ```
12
- β”œβ”€β”€ LICENSE <- Open-source license if one is chosen
13
- β”œβ”€β”€ Makefile <- Makefile with convenience commands like `make data` or `make train`
14
- β”œβ”€β”€ README.md <- The top-level README for developers using this project.
15
- β”œβ”€β”€ data
16
- β”‚ β”œβ”€β”€ external <- Data from third party sources.
17
- β”‚ β”œβ”€β”€ interim <- Intermediate data that has been transformed.
18
- β”‚ β”œβ”€β”€ processed <- The final, canonical data sets for modeling.
19
- β”‚ └── raw <- The original, immutable data dump.
20
- β”‚
21
- β”œβ”€β”€ docs <- A default mkdocs project; see www.mkdocs.org for details
22
- β”‚
23
- β”œβ”€β”€ models <- Trained and serialized models, model predictions, or model summaries
24
- β”‚
25
- β”œβ”€β”€ notebooks <- Jupyter notebooks. Naming convention is a number (for ordering),
26
- β”‚ the creator's initials, and a short `-` delimited description, e.g.
27
- β”‚ `1.0-jqp-initial-data-exploration`.
28
- β”‚
29
- β”œβ”€β”€ pyproject.toml <- Project configuration file with package metadata for
30
- β”‚ VitalMetrics and configuration for tools like black
31
- β”‚
32
- β”œβ”€β”€ references <- Data dictionaries, manuals, and all other explanatory materials.
33
- β”‚
34
- β”œβ”€β”€ reports <- Generated analysis as HTML, PDF, LaTeX, etc.
35
- β”‚ └── figures <- Generated graphics and figures to be used in reporting
36
- β”‚
37
- β”œβ”€β”€ requirements.txt <- The requirements file for reproducing the analysis environment, e.g.
38
- β”‚ generated with `pip freeze > requirements.txt`
39
- β”‚
40
- β”œβ”€β”€ setup.cfg <- Configuration file for flake8
41
- β”‚
42
- └── VitalMetrics <- Source code for use in this project.
43
- β”‚
44
- β”œβ”€β”€ __init__.py <- Makes VitalMetrics a Python module
45
- β”‚
46
- β”œβ”€β”€ config.py <- Store useful variables and configuration
47
- β”‚
48
- β”œβ”€β”€ dataset.py <- Scripts to download or generate data
49
- β”‚
50
- β”œβ”€β”€ features.py <- Code to create features for modeling
51
- β”‚
52
- β”œβ”€β”€ modeling
53
- β”‚ β”œβ”€β”€ __init__.py
54
- β”‚ β”œβ”€β”€ predict.py <- Code to run model inference with trained models
55
- β”‚ └── train.py <- Code to train models
56
- β”‚
57
- └── plots.py <- Code to create visualizations
58
- |
59
- |__ classifier.py
60
- ```
61
-
62
- --------
63
- ---
64
- title: PENGUINS CLASSIFIER
65
- emoji: πŸ“ˆ
66
- colorFrom: indigo
67
- colorTo: pink
68
- sdk: gradio
69
- sdk_version: 4.44.0
70
- app_file: app.py
71
- pinned: false
72
- license: apache-2.0
73
- ---
74
-
75
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
README_HF.md ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ title: PENGUINS CLASSIFIER
2
+ emoji: πŸ“ˆ
3
+ colorFrom: indigo
4
+ colorTo: pink
5
+ sdk: gradio
6
+ sdk_version: 4.44.0
7
+ app_file: app.py
8
+ pinned: false
9
+ license: apache-2.0