Skip to content

Commit

Permalink
change project description
Browse files Browse the repository at this point in the history
  • Loading branch information
amesval committed Mar 3, 2024
1 parent 6b8c53f commit 9bace14
Showing 1 changed file with 23 additions and 7 deletions.
30 changes: 23 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Salary classification for Census Income dataset

In this project we use demographic information to predict if a person has an anual income that exceeds $50k per year, based on census data (https://archive.ics.uci.edu/dataset/20/census+income).
The model is called from a FastAPI app that runs in a remote server (https://render.com/).

# Setup environment

Expand All @@ -24,6 +25,18 @@ conda activate <ENV_NAME>
pip install -r requirements.txt
```

# Data

TODO: Dataset location in the repository

# EDA

TODO: Explain EDA and were is located

# Training

TODO:

## Repositories
* Create a directory for the project and initialize git.
* As you work on the code, continually commit changes. Trained models you want to use in production must be committed to GitHub.
Expand All @@ -36,6 +49,10 @@ pip install -r requirements.txt
* This data is messy, try to open it in pandas and see what you get.
* To clean it, use your favorite text editor to remove all spaces.

En el folder data estan los datasets:
- census.csv
- clean_census.csv (version limpia del census)

# Model
* 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.
* Write unit tests for at least 3 functions in the model code.
Expand All @@ -60,12 +77,6 @@ pip install -r requirements.txt
* Hint: development in Python is fast! But how fast you can iterate slows down if you rely on your CI/CD to fail before fixing an issue. I like to run flake8 locally before I commit changes.
* Write a script that uses the requests module to do one POST on your live API.



# Title

# Setup

# Training

# Test?
Expand Down Expand Up @@ -200,4 +211,9 @@ is going to executre the 8 test cases (3 for the ./test_api.py and 5 ./test_func
7) Explain model?? (explain model metrics??)
8) Explain CI/CD with GitHub Actions
9) Explain screenshots
10) Explain model card
10) Explain model card


# TODO: After all
1) Rename repo
2) Change structure of the repo

0 comments on commit 9bace14

Please sign in to comment.