From ee48f15eee2a075767fd4315773d9a29e44af2f0 Mon Sep 17 00:00:00 2001 From: Eduard Date: Fri, 2 Feb 2018 19:56:25 +0300 Subject: [PATCH] Markdown formatting --- README.md | 50 +++++++++++++++++++++++++------------------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index eb74297..e4f7536 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # Samples-Data-Mining This is the README file for SAMPLES-DATA-MINING. The end of the file has setup instructions. -************************************************************************************ -Use or operation of this code is subject to acceptance of the license available in the code -repository for this code. -************************************************************************************ + +--- +Use or operation of this code is subject to acceptance of the license available in the code repository for this code. + +--- SAMPLES-DATA-MINING is meant for use with the InterSystems IRIS. It provides a copy of the Iris data set, which is well known in pattern recognition literature. You can use this data to explore the Predictive Model Markup Language (PMML) capability of InterSystems IRIS Data @@ -14,37 +15,36 @@ If you have a suitable license, you can also use this data with InterSystems IRI In addition to the data, the sample also includes various analytics model elements based on this data. -************************************************************************************ -Contents of the DataMining package -************************************************************************************ -* DataMining.IrisDataset is the core class. This class defines the data set. See - http://docs.intersystems.com/irislatest?KEY=APMML. -* DataMining.PMML.Iris defines a PMML model based on this data. See - http://docs.intersystems.com/irislatest?KEY=APMML. -* DataMining.IrisCube is a cube definition based on the same data. To use this class, +## Contents of the DataMining package + +* `DataMining.IrisDataset` is the core class. This class defines the data set. See [documentation](http://docs.intersystems.com/irislatest?KEY=APMML). +* `DataMining.PMML.Iris` defines a PMML model based on this data. See [documentation](http://docs.intersystems.com/irislatest?KEY=APMML). +* `DataMining.IrisCube` is a cube definition based on the same data. To use this class, you must have a license that includes analytics capabilities. -* The classes in DataMining.ClusterAnalysis provide a demo and test for the Cluster Analysis +* The classes in `DataMining.ClusterAnalysis` provide a demo and test for the Cluster Analysis algorithms included as part of the InterSystems IRIS analytics capabilities. To use this class, you must have a license that includes analytics capabilities. These classes all provide detailed descriptions, visible as part of the class reference. -After you have set up the sample, go to http://localhost:57772/csp/documatic/%25CSP.Documatic.cls +After you have set up the sample, go to the class reference: +``` +http://localhost:57772/csp/documatic/%25CSP.Documatic.cls +``` +Replace `localhost` with the name of your InterSystems IRIS server instance, and replace `57772` with the +webserver port used by that instance. -Replace localhost with the name of your InterSystems IRIS server instance, and replace 57772 with the -superserver port used by that instance. +## Setup instructions -************************************************************************************ -Setup instructions -************************************************************************************ 1. Download the repo to your local disk and uncompress it. 2. Open the InterSystems IRIS Terminal. -3. Enter the following command (replacing with the namespace where you want to load the sample): - - ZN "mynamespace" -4. Enter the following commands (replacing with the full path of the buildsample/buildsampledatamining.mac file): - +3. Enter the following command (replacing `` with the namespace where you want to load the sample): +``` + ZN "" +``` +4. Enter the following commands (replacing with the full path of the `buildsample/buildsampledatamining.mac` file): +``` do $system.OBJ.Load("full-path-to-buildsampledataminng.mac","ck") - do ^buildsampledata +``` 5. Then answer any prompts.