MCorr example notebook (#186) (#213)

* added data Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com> * updated dev guide Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com> * fixing dev guide Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com> * draft notebook Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com> * updating documentation Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com> * update Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com> * result visualization Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com> * minor fix Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com> * deleted unused labels Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com> * updated notebook Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com> --------- Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com> Signed-off-by: Alibi Zhenis <92104549+AlibiZhenis@users.noreply.github.com> (cherry picked from commit 0a0fa63) Co-authored-by: Alibi Zhenis <92104549+AlibiZhenis@users.noreply.github.com>
opensearch-project · Aug 10, 2023 · f048ed0 · f048ed0
1 parent b0b020e
commit f048ed0
Show file tree

Hide file tree

Showing 5 changed files with 521 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Added
 
 - adding documentation for model group id @dhrubo-os ([#176](https://github.com/opensearch-project/opensearch-py-ml/pull/176))
+- adding jupyter notebook based documentation for metrics correlation algorithm by @AlibiZhenis ([#186](https://github.com/opensearch-project/opensearch-py-ml/pull/186))
+
+### Changed
+-  Update jenkins file to use updated docker image ([#189](https://github.com/opensearch-project/opensearch-py-ml/pull/189)) 
 
 ### Fixed
 - Fix ModelUploader bug & Update model tracing demo notebook by @thanawan-atc in ([#185](https://github.com/opensearch-project/opensearch-py-ml/pull/185))

diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -95,7 +95,8 @@ You should paste this settings in the `Dev Tools` window and run it:
    "persistent" : {
      "plugins.ml_commons.only_run_on_ml_node" : false, 
      "plugins.ml_commons.native_memory_threshold" : 100, 
-     "plugins.ml_commons.max_model_on_node": 20
+     "plugins.ml_commons.max_model_on_node": 20,
+     "plugins.ml_commons.enable_inhouse_python_model": true
    }
  }
 ```

diff --git a/docs/source/examples/data/smd_data.csv b/docs/source/examples/data/smd_data.csv
diff --git a/docs/source/examples/demo_metrics_correlation.ipynb b/docs/source/examples/demo_metrics_correlation.ipynb
diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst
@@ -19,12 +19,20 @@ Demo notebooks for Model Training and Tracing
    :maxdepth: 1
 
    demo_transformer_model_train_save_upload_to_openSearch
-   demo_tracing_model_torchscript_onnx.ipynb
+   demo_tracing_model_torchscript_onnx
 
 Demo notebooks for ML Commons plugin integration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. toctree::
    :maxdepth: 1
 
-   demo_ml_commons_integration
+   demo_ml_commons_integration
+
+Demo Notebooks for In-house python based models
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 1
+
+   demo_metrics_correlation