diff --git a/README.md b/README.md index fad5b2eee..4ca9d7b48 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Data Science Project Boilerplate -This boilerplate is designed to kickstart data science projects by providing a basic setup for database connections, data processing, and machine learning model development. It includes a structured folder organization for your datasets and a set of pre-defined Python packages necessary for most data science tasks. + A simple Machine Learning project for training and testing models This boilerplate is designed to kickstart data science projects by providing a basic setup for database connections, data processing, and machine learning model development. It includes a structured folder organization for your datasets and a set of pre-defined Python packages necessary for most data science tasks. ## Structure The project is organized as follows: -- **`src/app.py`** → Main Python script where your project will run. +- **`src/app.py`** → Main Python script where your project will run. - **`src/explore.ipynb`** → Notebook for exploration and testing. Once exploration is complete, migrate the clean code to `app.py`. - **`src/utils.py`** → Auxiliary functions, such as database connection. - **`requirements.txt`** → List of required Python packages. @@ -109,4 +109,4 @@ To process data, you can modify the app.py script to include your data processin This template was built as part of the [Data Science and Machine Learning Bootcamp](https://4geeksacademy.com/us/coding-bootcamps/datascience-machine-learning) by 4Geeks Academy by [Alejandro Sanchez](https://twitter.com/alesanchezr) and many other contributors. Learn more about [4Geeks Academy BootCamp programs](https://4geeksacademy.com/us/programs) here. -Other templates and resources like this can be found on the school's GitHub page. \ No newline at end of file +Other templates and resources like this can be found on the school's GitHub page.