rortizmerino
commited on
Commit
•
b1a567f
1
Parent(s):
ac8b592
add license to README
Browse files
README.md
CHANGED
@@ -1,27 +1,6 @@
|
|
1 |
---
|
2 |
license: mit
|
3 |
---
|
4 |
-
Cookiecutter-MLOps
|
5 |
-
==============================
|
6 |
-
|
7 |
-
A cookiecutter template employing MLOps best practices, so you can focus on building machine learning products while
|
8 |
-
having MLOps best practices applied.
|
9 |
-
|
10 |
-
Instructions
|
11 |
-
------------
|
12 |
-
1. Clone the repo.
|
13 |
-
2. Run `make dirs` to create the missing parts of the directory structure described below.
|
14 |
-
3. *Optional:* Run `make virtualenv` to create a python virtual environment. Skip if using conda or some other env manager.
|
15 |
-
1. Run `source env/bin/activate` to activate the virtualenv.
|
16 |
-
4. Run `make requirements` to install required python packages.
|
17 |
-
5. Put the raw data in `data/raw`.
|
18 |
-
6. To save the raw data to the DVC cache, run `dvc add data/raw`
|
19 |
-
7. Edit the code files to your heart's desire.
|
20 |
-
8. Process your data, train and evaluate your model using `dvc repro` or `make reproduce`
|
21 |
-
9. To run the pre-commit hooks, run `make pre-commit-install`
|
22 |
-
10. For setting up data validation tests, run `make setup-setup-data-validation`
|
23 |
-
11. For **running** the data validation tests, run `make run-data-validation`
|
24 |
-
12. When you're happy with the result, commit files (including .dvc files) to git.
|
25 |
|
26 |
Project Organization
|
27 |
------------
|
@@ -78,4 +57,4 @@ Project Organization
|
|
78 |
|
79 |
To create a project like this, just go to https://dagshub.com/repo/create and select the **Cookiecutter DVC** project template.
|
80 |
|
81 |
-
Made with 🐶 by [DAGsHub](https://dagshub.com/).
|
|
|
1 |
---
|
2 |
license: mit
|
3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4 |
|
5 |
Project Organization
|
6 |
------------
|
|
|
57 |
|
58 |
To create a project like this, just go to https://dagshub.com/repo/create and select the **Cookiecutter DVC** project template.
|
59 |
|
60 |
+
Made with 🐶 by [DAGsHub](https://dagshub.com/).
|