From cde8801c1eacb8e0bcf20ae2023bf37ed0e53ac6 Mon Sep 17 00:00:00 2001 From: Michael Duong Date: Sat, 9 Sep 2023 10:13:37 +0000 Subject: [PATCH] add some documentation --- modules/ml-pipeline/README.MD | 12 +++++++++++- modules/ml-pipeline/src/pipeline/README.md | 3 +++ modules/ml-pipeline/src/pipeline2/README.md | 3 +++ 3 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 modules/ml-pipeline/src/pipeline/README.md create mode 100644 modules/ml-pipeline/src/pipeline2/README.md diff --git a/modules/ml-pipeline/README.MD b/modules/ml-pipeline/README.MD index 0b0f353..080838e 100644 --- a/modules/ml-pipeline/README.MD +++ b/modules/ml-pipeline/README.MD @@ -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 diff --git a/modules/ml-pipeline/src/pipeline/README.md b/modules/ml-pipeline/src/pipeline/README.md new file mode 100644 index 0000000..faef685 --- /dev/null +++ b/modules/ml-pipeline/src/pipeline/README.md @@ -0,0 +1,3 @@ +# Pipeline 1 + +Pipeline required to build a model to produce an output diff --git a/modules/ml-pipeline/src/pipeline2/README.md b/modules/ml-pipeline/src/pipeline2/README.md new file mode 100644 index 0000000..dbcce65 --- /dev/null +++ b/modules/ml-pipeline/src/pipeline2/README.md @@ -0,0 +1,3 @@ +# Pipeline2 + +PLACEHOLDER PIPELINE IF NEEDED