Updating documentment url and updating readme.md

abhatt1250 · abhatt1250 · commit 6c070de2cc31 · 2024-01-12T13:23:14.000+05:30
diff --git a/ml-insights/README.md b/ml-insights/README.md
@@ -56,6 +56,7 @@ Insights provides a simple, declarative API, out of box components covering majo
 | [ML Insights : Data Correlation Metrics](./sample_notebooks/11_Data_Correlation_Metrics.ipynb)                                         |
 | [ML Insights run with Custom Metrics](./sample_notebooks/12_Custom_Metrics_Example.ipynb)                                              |
 
-
+## Note
+The files [sum_divide_by_k_custom_metrics.py](./sample_notebooks/sum_divide_by_k_custom_metrics.py) and [sum_divide_by_two_custom_metrics.py](./sample_notebooks/sum_divide_by_two_custom_metrics.py) are examples of how to implement custom metrics and usage is demonstrated in sample notebook [ML Insights run with Custom Metrics](./sample_notebooks/12_Custom_Metrics_Example.ipynb).  
 
 
diff --git a/ml-insights/sample_notebooks/10_Drift_Metrics.ipynb b/ml-insights/sample_notebooks/10_Drift_Metrics.ipynb
@@ -61,7 +61,7 @@
     "      !pip install oracle-ml-insights\n",
     "\n",
     "\n",
-    "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n",
+    "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n",
     " "
    ]
   },
diff --git a/ml-insights/sample_notebooks/11_Data_Correlation_Metrics.ipynb b/ml-insights/sample_notebooks/11_Data_Correlation_Metrics.ipynb
@@ -62,7 +62,7 @@
     "\n",
     "      !pip install oracle-ml-insights\n",
     "\n",
-    "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n",
+    "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n",
     " "
    ]
   },
diff --git a/ml-insights/sample_notebooks/12_Custom_Metrics_Example.ipynb b/ml-insights/sample_notebooks/12_Custom_Metrics_Example.ipynb
@@ -53,7 +53,7 @@
     "\n",
     "      !pip install oracle-ml-insights\n",
     "\n",
-    "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n",
+    "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n",
     " "
    ]
   },
diff --git a/ml-insights/sample_notebooks/1_Minimal_ML_Insights.ipynb b/ml-insights/sample_notebooks/1_Minimal_ML_Insights.ipynb
@@ -64,15 +64,15 @@
     "\n",
     "      !pip install oracle-ml-insights\n",
     "\n",
-    "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)"
+    "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "01d44554",
    "metadata": {},
    "source": [
-    "This example notebook showcases how to use Insights config reader to run the evaluation based on monitor config.  Sample monitor config JSON and sample data are available under `monitor_config.json` and `input_data/iris-dataset` respectively"
+    "This example notebook showcases how to use Insights config reader to run the evaluation based on monitor config.  Sample monitor config JSON and sample data are available under `config/monitor_config.json` and `input_data/iris-dataset` respectively"
    ]
   },
   {
diff --git a/ml-insights/sample_notebooks/2_Run_ML_Insights_using_config_file.ipynb b/ml-insights/sample_notebooks/2_Run_ML_Insights_using_config_file.ipynb
@@ -44,15 +44,15 @@
     "      !pip install oracle-ml-insights\n",
     "\n",
     "\n",
-    "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n"
+    "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "13b3fd12",
    "metadata": {},
    "source": [
-    "This example notebook showcases how to use Insights config reader to run the evaluation based on monitor config.  Sample monitor config JSON and sample data are available under `monitor_config.json` and `input_data/iris-dataset` respectively"
+    "This example notebook showcases how to use Insights config reader to run the evaluation based on monitor config.  Sample monitor config JSON and sample data are available under `config/monitor_config.json` and `input_data/iris-dataset` respectively"
    ]
   },
   {
@@ -97,7 +97,7 @@
     "\n",
     "ML Insights provides low code option to define and customise all of its core features like data scheme , data ingestion, data transformation, metric calculation and post processing of metric output using json based configuration .\n",
     "\n",
-    "Refer : [ML Insights Config File Documentation](https://confluence.oci.oraclecorp.com/pages/viewpage.action?spaceKey=ODSC&title=ML+Insights+-Steps+to+create+insights+config+file)\n",
+    "Refer : [ML Insights Config File Documentation](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/config_reader.html)\n",
     "\n"
    ]
   },
@@ -121,7 +121,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "insights_builder = InsightsConfigReader(config_location=\"monitor_config.json\").get_builder()\n",
+    "insights_builder = InsightsConfigReader(config_location=\"config/monitor_config.json\").get_builder()\n",
     "run_result = insights_builder.build().run()\n",
     "profile = run_result.profile\n"
    ]
diff --git a/ml-insights/sample_notebooks/3_Run_ML_Insights_using_api.ipynb b/ml-insights/sample_notebooks/3_Run_ML_Insights_using_api.ipynb
@@ -116,7 +116,7 @@
     "\n",
     "      !pip install oracle-ml-insights\n",
     "\n",
-    "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n"
+    "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n"
    ]
   },
   {
diff --git a/ml-insights/sample_notebooks/4_Data_Source_and_Reader_Example.ipynb b/ml-insights/sample_notebooks/4_Data_Source_and_Reader_Example.ipynb
@@ -37,7 +37,7 @@
     "\n",
     "      !pip install oracle-ml-insights\n",
     "\n",
-    "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n",
+    "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n",
     " "
    ]
   },
diff --git a/ml-insights/sample_notebooks/5_Post_Processor_Profile_Writer_Example.ipynb b/ml-insights/sample_notebooks/5_Post_Processor_Profile_Writer_Example.ipynb
@@ -40,7 +40,7 @@
     "\n",
     "      !pip install oracle-ml-insights\n",
     "\n",
-    "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)"
+    "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)"
    ]
   },
   {
diff --git a/ml-insights/sample_notebooks/6_Data_Quality_and_Data_Integrity_Metrics.ipynb b/ml-insights/sample_notebooks/6_Data_Quality_and_Data_Integrity_Metrics.ipynb
@@ -73,7 +73,7 @@
     "\n",
     "      !pip install oracle-ml-insights\n",
     "\n",
-    "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n"
+    "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n"
    ]
   },
   {
diff --git a/ml-insights/sample_notebooks/7_Performance_Metric_For_Classification_Models.ipynb b/ml-insights/sample_notebooks/7_Performance_Metric_For_Classification_Models.ipynb
@@ -74,7 +74,7 @@
     "\n",
     "      !pip install oracle-ml-insights\n",
     "\n",
-    "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)"
+    "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)"
    ]
   },
   {
diff --git a/ml-insights/sample_notebooks/8_Conflict_Metrics.ipynb b/ml-insights/sample_notebooks/8_Conflict_Metrics.ipynb
@@ -52,7 +52,7 @@
     "\n",
     "      !pip install oracle-ml-insights\n",
     "\n",
-    "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n",
+    "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n",
     " "
    ]
   },
diff --git a/ml-insights/sample_notebooks/9_Performance_Metrics_for_Regression_Model.ipynb b/ml-insights/sample_notebooks/9_Performance_Metrics_for_Regression_Model.ipynb
@@ -59,7 +59,7 @@
     "      !pip install oracle-ml-insights\n",
     "\n",
     "\n",
-    "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n",
+    "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n",
     " "
    ]
   },
diff --git a/ml-insights/sample_notebooks/config/monitor_config.json b/ml-insights/sample_notebooks/config/monitor_config.json

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@`
`61`	`61`	`" !pip install oracle-ml-insights\n",`
`62`	`62`	`"\n",`
`63`	`63`	`"\n",`
`64`		`- "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n",`
	`64`	`+ "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n",`
`65`	`65`	`" "`
`66`	`66`	`]`
`67`	`67`	`},`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@`
`62`	`62`	`"\n",`
`63`	`63`	`" !pip install oracle-ml-insights\n",`
`64`	`64`	`"\n",`
`65`		`- "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n",`
	`65`	`+ "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n",`
`66`	`66`	`" "`
`67`	`67`	`]`
`68`	`68`	`},`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@`
`53`	`53`	`"\n",`
`54`	`54`	`" !pip install oracle-ml-insights\n",`
`55`	`55`	`"\n",`
`56`		`- "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n",`
	`56`	`+ "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n",`
`57`	`57`	`" "`
`58`	`58`	`]`
`59`	`59`	`},`
Original file line number	Diff line number	Diff line change
`@@ -64,15 +64,15 @@`
`64`	`64`	`"\n",`
`65`	`65`	`" !pip install oracle-ml-insights\n",`
`66`	`66`	`"\n",`
`67`		`- "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)"`
	`67`	`+ "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)"`
`68`	`68`	`]`
`69`	`69`	`},`
`70`	`70`	`{`
`71`	`71`	`"cell_type": "markdown",`
`72`	`72`	`"id": "01d44554",`
`73`	`73`	`"metadata": {},`
`74`	`74`	`"source": [`
`75`		- "This example notebook showcases how to use Insights config reader to run the evaluation based on monitor config. Sample monitor config JSON and sample data are available under `monitor_config.json` and `input_data/iris-dataset` respectively"
	`75`	+ "This example notebook showcases how to use Insights config reader to run the evaluation based on monitor config. Sample monitor config JSON and sample data are available under `config/monitor_config.json` and `input_data/iris-dataset` respectively"
`76`	`76`	`]`
`77`	`77`	`},`
`78`	`78`	`{`
Original file line number	Diff line number	Diff line change
`@@ -44,15 +44,15 @@`
`44`	`44`	`" !pip install oracle-ml-insights\n",`
`45`	`45`	`"\n",`
`46`	`46`	`"\n",`
`47`		`- "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n"`
	`47`	`+ "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n"`
`48`	`48`	`]`
`49`	`49`	`},`
`50`	`50`	`{`
`51`	`51`	`"cell_type": "markdown",`
`52`	`52`	`"id": "13b3fd12",`
`53`	`53`	`"metadata": {},`
`54`	`54`	`"source": [`
`55`		- "This example notebook showcases how to use Insights config reader to run the evaluation based on monitor config. Sample monitor config JSON and sample data are available under `monitor_config.json` and `input_data/iris-dataset` respectively"
	`55`	+ "This example notebook showcases how to use Insights config reader to run the evaluation based on monitor config. Sample monitor config JSON and sample data are available under `config/monitor_config.json` and `input_data/iris-dataset` respectively"
`56`	`56`	`]`
`57`	`57`	`},`
`58`	`58`	`{`
`@@ -97,7 +97,7 @@`
`97`	`97`	`"\n",`
`98`	`98`	`"ML Insights provides low code option to define and customise all of its core features like data scheme , data ingestion, data transformation, metric calculation and post processing of metric output using json based configuration .\n",`
`99`	`99`	`"\n",`
`100`		`- "Refer : [ML Insights Config File Documentation](https://confluence.oci.oraclecorp.com/pages/viewpage.action?spaceKey=ODSC&title=ML+Insights+-Steps+to+create+insights+config+file)\n",`
	`100`	`+ "Refer : [ML Insights Config File Documentation](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/config_reader.html)\n",`
`101`	`101`	`"\n"`
`102`	`102`	`]`
`103`	`103`	`},`
`@@ -121,7 +121,7 @@`
`121`	`121`	`"metadata": {},`
`122`	`122`	`"outputs": [],`
`123`	`123`	`"source": [`
`124`		`- "insights_builder = InsightsConfigReader(config_location=\"monitor_config.json\").get_builder()\n",`
	`124`	`+ "insights_builder = InsightsConfigReader(config_location=\"config/monitor_config.json\").get_builder()\n",`
`125`	`125`	`"run_result = insights_builder.build().run()\n",`
`126`	`126`	`"profile = run_result.profile\n"`
`127`	`127`	`]`
Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@`
`116`	`116`	`"\n",`
`117`	`117`	`" !pip install oracle-ml-insights\n",`
`118`	`118`	`"\n",`
`119`		`- "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n"`
	`119`	`+ "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n"`
`120`	`120`	`]`
`121`	`121`	`},`
`122`	`122`	`{`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@`
`37`	`37`	`"\n",`
`38`	`38`	`" !pip install oracle-ml-insights\n",`
`39`	`39`	`"\n",`
`40`		`- "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n",`
	`40`	`+ "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n",`
`41`	`41`	`" "`
`42`	`42`	`]`
`43`	`43`	`},`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@`
`40`	`40`	`"\n",`
`41`	`41`	`" !pip install oracle-ml-insights\n",`
`42`	`42`	`"\n",`
`43`		`- "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)"`
	`43`	`+ "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)"`
`44`	`44`	`]`
`45`	`45`	`},`
`46`	`46`	`{`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@`
`73`	`73`	`"\n",`
`74`	`74`	`" !pip install oracle-ml-insights\n",`
`75`	`75`	`"\n",`
`76`		`- "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)\n"`
	`76`	`+ "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)\n"`
`77`	`77`	`]`
`78`	`78`	`},`
`79`	`79`	`{`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@`
`74`	`74`	`"\n",`
`75`	`75`	`" !pip install oracle-ml-insights\n",`
`76`	`76`	`"\n",`
`77`		`- "Refer : [Installation and Setup](https://preview.content.oci.oracleiaas.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html?bundle=16676&showfilteredtoc=true)"`
	`77`	`+ "Refer : [Installation and Setup](https://docs.oracle.com/iaas/tools/ml-insights-docs/latest/ml-insights-documentation/html/user_guide/tutorials/install.html)"`
`78`	`78`	`]`
`79`	`79`	`},`
`80`	`80`	`{`