Skip to content

Commit e1662e8

Browse files
authored
Update README.md
1 parent 46b16fe commit e1662e8

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

Diff for: README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,20 @@ Working in a command line environment is recommended for ease of use with git an
33
# Environment Set up
44
* Download and install conda if you don’t have it already.
55
* Use the supplied requirements file to create a new environment, or
6-
* conda create -n [envname] "python=3.8" scikit-learn dvc pandas numpy pytest jupyter jupyterlab fastapi uvicorn -c conda-forge
6+
* conda create -n [envname] "python=3.8" scikit-learn pandas numpy pytest jupyter jupyterlab fastapi uvicorn -c conda-forge
77
* Install git either through conda (“conda install git”) or through your CLI, e.g. sudo apt-get git.
88

99
## Repositories
10-
* Create a directory for the project and initialize git and dvc.
11-
* As you work on the code, continually commit changes. Generated models you want to keep must be committed to dvc.
10+
* Create a directory for the project and initialize git.
11+
* As you work on the code, continually commit changes. Trained models you want to use in production must be committed to GitHub.
1212
* Connect your local git repo to GitHub.
1313
* Setup GitHub Actions on your repo. You can use one of the pre-made GitHub Actions if at a minimum it runs pytest and flake8 on push and requires both to pass without error.
1414
* Make sure you set up the GitHub Action to have the same version of Python as you used in development.
15-
* Set up a remote repository for dvc.
1615

1716
# Data
1817
* Download census.csv and commit it to dvc.
1918
* This data is messy, try to open it in pandas and see what you get.
2019
* To clean it, use your favorite text editor to remove all spaces.
21-
* Commit this modified data to dvc (we often want to keep the raw data untouched but then can keep updating the cooked version).
2220

2321
# Model
2422
* Using the starter code, write a machine learning model that trains on the clean data and saves the model. Complete any function that has been started.

0 commit comments

Comments
 (0)