Skip to content

Commit

Permalink
docs: add documentation to the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
fedepacher committed Jun 9, 2023
1 parent ad2b8b9 commit 8d45993
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ the possible movie choices of the concerned user and their preferences towards a

This is a project for the **SoyHenry** academy.

## Repository content

+ **etl.ipynb**: Content the ETL process for the `CSV` files and create a clean `CSV`.
+ **movies.py**: Content the class to process api requests.
+ **api.py**: Content the `GET` method to process server requests.
+ **eda.ipynb**: Content the EDA process and recomendation system.

## Workflow

Expand All @@ -32,6 +38,11 @@ For this task it has created the following [issue](https://github.com/fedepacher

For this task it has created the following [issue](https://github.com/fedepacher/RecomendationML/issues/2) where you can find the description of the task to solve.<br>
It has the following [issue](https://github.com/fedepacher/RecomendationML/issues/3) related.

## Deployment

To deploy the environment it has ussed the following [tutorial](https://github.com/HX-FNegrete/render-fastapi-tutorial). The related issue can be found [here](https://github.com/fedepacher/RecomendationML/issues/4).

## Exploratory data analysis

For this task it has created the following [issue](https://github.com/fedepacher/RecomendationML/issues/5) where you can find all the related information.<br>

0 comments on commit 8d45993

Please sign in to comment.