mirror of
https://github.com/Hestia-Homes/ML.git
synced 2026-06-08 11:17:25 +00:00
add some documentation
This commit is contained in:
parent
0d18b440c1
commit
cde8801c1e
3 changed files with 17 additions and 1 deletions
|
|
@ -1,3 +1,13 @@
|
|||
# ML-pipeline
|
||||
|
||||
This is a dummy ML-pipeline
|
||||
This is a dummy ML-pipeline, consisting of:
|
||||
- dvc tracking for version control (data and models)
|
||||
- gto for model registry
|
||||
- docs, created via sphinx (in pre-commit hooks)
|
||||
- tests for unit, integration and end to end testing
|
||||
|
||||
Within `src` folder, the structure is as follows:
|
||||
- multiple pipelines can be defined
|
||||
- i.e. for a product, we might require multuple pipelines do deliver a result
|
||||
- i.e. multiple models
|
||||
- these models can be all tracked within the same gto model registry
|
||||
|
|
|
|||
3
modules/ml-pipeline/src/pipeline/README.md
Normal file
3
modules/ml-pipeline/src/pipeline/README.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Pipeline 1
|
||||
|
||||
Pipeline required to build a model to produce an output
|
||||
3
modules/ml-pipeline/src/pipeline2/README.md
Normal file
3
modules/ml-pipeline/src/pipeline2/README.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Pipeline2
|
||||
|
||||
PLACEHOLDER PIPELINE IF NEEDED
|
||||
Loading…
Add table
Reference in a new issue