diff --git a/README.md b/README.md index ae02efb999..b462eb229d 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ [![Build Status](https://msdata.visualstudio.com/A365/_apis/build/status/microsoft.SynapseML?branchName=master)](https://msdata.visualstudio.com/A365/_build/latest?definitionId=17563&branchName=master) [![codecov](https://codecov.io/gh/Microsoft/SynapseML/branch/master/graph/badge.svg)](https://codecov.io/gh/Microsoft/SynapseML) [![Gitter](https://badges.gitter.im/Microsoft/MMLSpark.svg)](https://gitter.im/Microsoft/MMLSpark?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) -[![Release Notes](https://img.shields.io/badge/release-notes-blue)](https://github.com/Microsoft/SynapseML/releases) [![Scala Docs](https://img.shields.io/static/v1?label=api%20docs&message=scala&color=blue&logo=scala)](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/index.html#package) [![PySpark Docs](https://img.shields.io/static/v1?label=api%20docs&message=python&color=blue&logo=python)](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/index.html) [![Academic Paper](https://img.shields.io/badge/academic-paper-7fdcf7)](https://arxiv.org/abs/1810.08744) +[![Release Notes](https://img.shields.io/badge/release-notes-blue)](https://github.com/Microsoft/SynapseML/releases) [![Scala Docs](https://img.shields.io/static/v1?label=api%20docs&message=scala&color=blue&logo=scala)](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/index.html#package) [![PySpark Docs](https://img.shields.io/static/v1?label=api%20docs&message=python&color=blue&logo=python)](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/index.html) [![Academic Paper](https://img.shields.io/badge/academic-paper-7fdcf7)](https://arxiv.org/abs/1810.08744) -[![Version](https://img.shields.io/badge/version-0.9.4-blue)](https://github.com/Microsoft/SynapseML/releases) [![Snapshot Version](https://mmlspark.blob.core.windows.net/icons/badges/master_version3.svg)](#sbt) +[![Version](https://img.shields.io/badge/version-0.9.5-blue)](https://github.com/Microsoft/SynapseML/releases) [![Snapshot Version](https://mmlspark.blob.core.windows.net/icons/badges/master_version3.svg)](#sbt) SynapseML (previously MMLSpark) is an open source library to simplify the creation of scalable machine learning pipelines. @@ -28,8 +28,8 @@ sub-millisecond latency web services, backed by your Spark cluster. SynapseML requires Scala 2.12, Spark 3.0+, and Python 3.6+. See the API documentation [for -Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/index.html#package) and [for -PySpark](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/index.html). +Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/index.html#package) and [for +PySpark](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/index.html).
Table of Contents @@ -82,7 +82,7 @@ the above example, or from python: ```python import pyspark spark = pyspark.sql.SparkSession.builder.appName("MyApp") \ - .config("spark.jars.packages", "com.microsoft.azure:synapseml_2.12:0.9.4") \ + .config("spark.jars.packages", "com.microsoft.azure:synapseml_2.12:0.9.5") \ .config("spark.jars.repositories", "https://mmlspark.azureedge.net/maven") \ .getOrCreate() import synapse.ml @@ -95,7 +95,7 @@ your `build.sbt`: ```scala resolvers += "SynapseML" at "https://mmlspark.azureedge.net/maven" -libraryDependencies += "com.microsoft.azure" % "synapseml_2.12" % "0.9.4" +libraryDependencies += "com.microsoft.azure" % "synapseml_2.12" % "0.9.5" ``` @@ -105,9 +105,9 @@ SynapseML can be conveniently installed on existing Spark clusters via the `--packages` option, examples: ```bash -spark-shell --packages com.microsoft.azure:synapseml_2.12:0.9.4 --conf spark.jars.repositories=https://mmlspark.azureedge.net/maven -pyspark --packages com.microsoft.azure:synapseml_2.12:0.9.4 --conf spark.jars.repositories=https://mmlspark.azureedge.net/maven -spark-submit --packages com.microsoft.azure:synapseml_2.12:0.9.4 MyApp.jar --conf spark.jars.repositories=https://mmlspark.azureedge.net/maven +spark-shell --packages com.microsoft.azure:synapseml_2.12:0.9.5 --conf spark.jars.repositories=https://mmlspark.azureedge.net/maven +pyspark --packages com.microsoft.azure:synapseml_2.12:0.9.5 --conf spark.jars.repositories=https://mmlspark.azureedge.net/maven +spark-submit --packages com.microsoft.azure:synapseml_2.12:0.9.5 MyApp.jar --conf spark.jars.repositories=https://mmlspark.azureedge.net/maven ``` This can be used in other Spark contexts too. For example, you can use SynapseML @@ -122,7 +122,7 @@ cloud](http://community.cloud.databricks.com), create a new [library from Maven coordinates](https://docs.databricks.com/user-guide/libraries.html#libraries-from-maven-pypi-or-spark-packages) in your workspace. -For the coordinates use: `com.microsoft.azure:synapseml_2.12:0.9.4` +For the coordinates use: `com.microsoft.azure:synapseml_2.12:0.9.5` with the resolver: `https://mmlspark.azureedge.net/maven`. Ensure this library is attached to your target cluster(s). @@ -130,7 +130,7 @@ Finally, ensure that your Spark cluster has at least Spark 3.12 and Scala 2.12. You can use SynapseML in both your Scala and PySpark notebooks. To get started with our example notebooks import the following databricks archive: -`https://mmlspark.blob.core.windows.net/dbcs/SynapseMLExamplesv0.9.4.dbc` +`https://mmlspark.blob.core.windows.net/dbcs/SynapseMLExamplesv0.9.5.dbc` ### Apache Livy and HDInsight @@ -143,7 +143,7 @@ Excluding certain packages from the library may be necessary due to current issu { "name": "synapseml", "conf": { - "spark.jars.packages": "com.microsoft.azure:synapseml_2.12:0.9.4", + "spark.jars.packages": "com.microsoft.azure:synapseml_2.12:0.9.5", "spark.jars.repositories": "https://mmlspark.azureedge.net/maven", "spark.jars.excludes": "org.scala-lang:scala-reflect,org.apache.spark:spark-tags_2.12,org.scalactic:scalactic_2.12,org.scalatest:scalatest_2.12" } @@ -157,7 +157,7 @@ In Azure Synapse, "spark.yarn.user.classpath.first" should be set to "true" to o { "name": "synapseml", "conf": { - "spark.jars.packages": "com.microsoft.azure:synapseml_2.12:0.9.4", + "spark.jars.packages": "com.microsoft.azure:synapseml_2.12:0.9.5", "spark.jars.repositories": "https://mmlspark.azureedge.net/maven", "spark.jars.excludes": "org.scala-lang:scala-reflect,org.apache.spark:spark-tags_2.12,org.scalactic:scalactic_2.12,org.scalatest:scalatest_2.12", "spark.yarn.user.classpath.first": "true" diff --git a/build.sbt b/build.sbt index 668f61ab0a..c80b933ef1 100644 --- a/build.sbt +++ b/build.sbt @@ -64,8 +64,6 @@ def pomPostFunc(node: XmlNode): scala.xml.Node = { pomPostProcess := pomPostFunc -val speechResolver = "Speech" at "https://mmlspark.blob.core.windows.net/maven/" - val getDatasetsTask = TaskKey[Unit]("getDatasets", "download datasets used for testing") val datasetName = "datasets-2021-12-10.tgz" val datasetUrl = new URL(s"https://mmlspark.blob.core.windows.net/installers/$datasetName") @@ -213,20 +211,6 @@ publishDocs := { uploadToBlob(unifiedDocDir.toString, version.value, "docs") } -val release = TaskKey[Unit]("release", "publish the library to synapseml blob") -release := Def.taskDyn { - val v = isSnapshot.value - if (!v) { - Def.task { - sonatypeBundleRelease.value - } - } else { - Def.task { - "Not a release" - } - } -} - val publishBadges = TaskKey[Unit]("publishBadges", "publish badges to synapseml blob") publishBadges := { def enc(s: String): String = { @@ -310,11 +294,10 @@ lazy val cognitive = (project in file("cognitive")) .dependsOn(core % "test->test;compile->compile") .settings(settings ++ Seq( libraryDependencies ++= Seq( - "com.microsoft.cognitiveservices.speech" % "client-sdk" % "1.14.0", + "com.microsoft.cognitiveservices.speech" % "client-jar-sdk" % "1.14.0", "com.azure" % "azure-storage-blob" % "12.14.2", "com.azure" % "azure-ai-textanalytics" % "5.1.4", ), - resolvers += speechResolver, name := "synapseml-cognitive" ): _*) diff --git a/notebooks/features/cognitive_services/CognitiveServices - Overview.ipynb b/notebooks/features/cognitive_services/CognitiveServices - Overview.ipynb index df796c6e65..0bd793ac2c 100644 --- a/notebooks/features/cognitive_services/CognitiveServices - Overview.ipynb +++ b/notebooks/features/cognitive_services/CognitiveServices - Overview.ipynb @@ -30,66 +30,66 @@ "\n", "### Vision\n", "[**Computer Vision**](https://azure.microsoft.com/en-us/services/cognitive-services/computer-vision/)\n", - "- Describe: provides description of an image in human readable language ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/DescribeImage.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DescribeImage))\n", - "- Analyze (color, image type, face, adult/racy content): analyzes visual features of an image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeImage.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeImage))\n", - "- OCR: reads text from an image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/OCR.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.OCR))\n", - "- Recognize Text: reads text from an image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/RecognizeText.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.RecognizeText))\n", - "- Thumbnail: generates a thumbnail of user-specified size from the image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/GenerateThumbnails.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.GenerateThumbnails))\n", - "- Recognize domain-specific content: recognizes domain-specific content (celebrity, landmark) ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/RecognizeDomainSpecificContent.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.RecognizeDomainSpecificContent))\n", - "- Tag: identifies list of words that are relevant to the in0put image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/TagImage.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.TagImage))\n", + "- Describe: provides description of an image in human readable language ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DescribeImage.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DescribeImage))\n", + "- Analyze (color, image type, face, adult/racy content): analyzes visual features of an image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeImage.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeImage))\n", + "- OCR: reads text from an image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/OCR.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.OCR))\n", + "- Recognize Text: reads text from an image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/RecognizeText.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.RecognizeText))\n", + "- Thumbnail: generates a thumbnail of user-specified size from the image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/GenerateThumbnails.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.GenerateThumbnails))\n", + "- Recognize domain-specific content: recognizes domain-specific content (celebrity, landmark) ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/RecognizeDomainSpecificContent.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.RecognizeDomainSpecificContent))\n", + "- Tag: identifies list of words that are relevant to the in0put image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/TagImage.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.TagImage))\n", "\n", "[**Face**](https://azure.microsoft.com/en-us/services/cognitive-services/face/)\n", - "- Detect: detects human faces in an image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/DetectFace.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DetectFace))\n", - "- Verify: verifies whether two faces belong to a same person, or a face belongs to a person ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/VerifyFaces.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.VerifyFaces))\n", - "- Identify: finds the closest matches of the specific query person face from a person group ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/IdentifyFaces.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.IdentifyFaces))\n", - "- Find similar: finds similar faces to the query face in a face list ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/FindSimilarFace.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.FindSimilarFace))\n", - "- Group: divides a group of faces into disjoint groups based on similarity ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/GroupFaces.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.GroupFaces))\n", + "- Detect: detects human faces in an image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DetectFace.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DetectFace))\n", + "- Verify: verifies whether two faces belong to a same person, or a face belongs to a person ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/VerifyFaces.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.VerifyFaces))\n", + "- Identify: finds the closest matches of the specific query person face from a person group ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/IdentifyFaces.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.IdentifyFaces))\n", + "- Find similar: finds similar faces to the query face in a face list ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/FindSimilarFace.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.FindSimilarFace))\n", + "- Group: divides a group of faces into disjoint groups based on similarity ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/GroupFaces.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.GroupFaces))\n", "\n", "### Speech\n", "[**Speech Services**](https://azure.microsoft.com/en-us/services/cognitive-services/speech-services/)\n", - "- Speech-to-text: transcribes audio streams ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/SpeechToText.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.SpeechToText))\n", - "- Conversation Transcription: transcribes audio streams into live transcripts with identified speakers. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/ConversationTranscription.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.ConversationTranscription))\n", - "- Text to Speech: Converts text to realistic audio ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4-41-9e51ba7d-SNAPSHOT/scala/com/microsoft/azure/synapse/ml/cognitive/TextToSpeech.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4-41-9e51ba7d-SNAPSHOT/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.TextToSpeech))\n", + "- Speech-to-text: transcribes audio streams ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/SpeechToText.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.SpeechToText))\n", + "- Conversation Transcription: transcribes audio streams into live transcripts with identified speakers. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/ConversationTranscription.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.ConversationTranscription))\n", + "- Text to Speech: Converts text to realistic audio ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/TextToSpeech.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.TextToSpeech))\n", "\n", "\n", "### Language\n", "[**Text Analytics**](https://azure.microsoft.com/en-us/services/cognitive-services/text-analytics/)\n", - "- Language detection: detects language of the input text ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/LanguageDetector.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.LanguageDetector))\n", - "- Key phrase extraction: identifies the key talking points in the input text ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/KeyPhraseExtractor.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.KeyPhraseExtractor))\n", - "- Named entity recognition: identifies known entities and general named entities in the input text ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/NER.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.NER))\n", - "- Sentiment analysis: returns a score betwee 0 and 1 indicating the sentiment in the input text ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/TextSentiment.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.TextSentiment))\n", - "- Healthcare Entity Extraction: Extracts medical entities and relationships from text. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4-41-9e51ba7d-SNAPSHOT/scala/com/microsoft/azure/synapse/ml/cognitive/HealthcareSDK.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4-41-9e51ba7d-SNAPSHOT/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.HealthcareSDK))\n", + "- Language detection: detects language of the input text ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/LanguageDetector.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.LanguageDetector))\n", + "- Key phrase extraction: identifies the key talking points in the input text ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/KeyPhraseExtractor.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.KeyPhraseExtractor))\n", + "- Named entity recognition: identifies known entities and general named entities in the input text ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/NER.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.NER))\n", + "- Sentiment analysis: returns a score betwee 0 and 1 indicating the sentiment in the input text ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/TextSentiment.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.TextSentiment))\n", + "- Healthcare Entity Extraction: Extracts medical entities and relationships from text. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/HealthcareSDK.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.HealthcareSDK))\n", "\n", "\n", "### Translation\n", "[**Translator**](https://azure.microsoft.com/en-us/services/cognitive-services/translator/)\n", - "- Translate: Translates text. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/Translate.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.Translate))\n", - "- Transliterate: Converts text in one language from one script to another script. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/Transliterate.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.Transliterate))\n", - "- Detect: Identifies the language of a piece of text. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/Detect.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.Detect))\n", - "- BreakSentence: Identifies the positioning of sentence boundaries in a piece of text. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/BreakSentence.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.BreakSentence))\n", - "- Dictionary Lookup: Provides alternative translations for a word and a small number of idiomatic phrases. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/DictionaryLookup.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DictionaryLookup))\n", - "- Dictionary Examples: Provides examples that show how terms in the dictionary are used in context. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/DictionaryExamples.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DictionaryExamples))\n", - "- Document Translation: Translates documents across all supported languages and dialects while preserving document structure and data format. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/DocumentTranslator.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DocumentTranslator))\n", + "- Translate: Translates text. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/Translate.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.Translate))\n", + "- Transliterate: Converts text in one language from one script to another script. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/Transliterate.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.Transliterate))\n", + "- Detect: Identifies the language of a piece of text. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/Detect.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.Detect))\n", + "- BreakSentence: Identifies the positioning of sentence boundaries in a piece of text. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/BreakSentence.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.BreakSentence))\n", + "- Dictionary Lookup: Provides alternative translations for a word and a small number of idiomatic phrases. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DictionaryLookup.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DictionaryLookup))\n", + "- Dictionary Examples: Provides examples that show how terms in the dictionary are used in context. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DictionaryExamples.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DictionaryExamples))\n", + "- Document Translation: Translates documents across all supported languages and dialects while preserving document structure and data format. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DocumentTranslator.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DocumentTranslator))\n", "\n", "### Form Recognizer\n", "[**Form Recognizer**](https://azure.microsoft.com/en-us/services/form-recognizer/)\n", - "- Analyze Layout: Extract text and layout information from a given document. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeLayout.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeLayout))\n", - "- Analyze Receipts: Detects and extracts data from receipts using optical character recognition (OCR) and our receipt model, enabling you to easily extract structured data from receipts such as merchant name, merchant phone number, transaction date, transaction total, and more. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeReceipts.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeReceipts))\n", - "- Analyze Business Cards: Detects and extracts data from business cards using optical character recognition (OCR) and our business card model, enabling you to easily extract structured data from business cards such as contact names, company names, phone numbers, emails, and more. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeBusinessCards.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeBusinessCards))\n", - "- Analyze Invoices: Detects and extracts data from invoices using optical character recognition (OCR) and our invoice understanding deep learning models, enabling you to easily extract structured data from invoices such as customer, vendor, invoice ID, invoice due date, total, invoice amount due, tax amount, ship to, bill to, line items and more. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeInvoices.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeInvoices))\n", - "- Analyze ID Documents: Detects and extracts data from identification documents using optical character recognition (OCR) and our ID document model, enabling you to easily extract structured data from ID documents such as first name, last name, date of birth, document number, and more. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeIDDocuments.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeIDDocuments))\n", - "- Analyze Custom Form: Extracts information from forms (PDFs and images) into structured data based on a model created from a set of representative training forms. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeCustomModel.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeCustomModel))\n", - "- Get Custom Model: Get detailed information about a custom model. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/GetCustomModel.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/ListCustomModels.html))\n", - "- List Custom Models: Get information about all custom models. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/ListCustomModels.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.ListCustomModels))\n", + "- Analyze Layout: Extract text and layout information from a given document. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeLayout.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeLayout))\n", + "- Analyze Receipts: Detects and extracts data from receipts using optical character recognition (OCR) and our receipt model, enabling you to easily extract structured data from receipts such as merchant name, merchant phone number, transaction date, transaction total, and more. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeReceipts.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeReceipts))\n", + "- Analyze Business Cards: Detects and extracts data from business cards using optical character recognition (OCR) and our business card model, enabling you to easily extract structured data from business cards such as contact names, company names, phone numbers, emails, and more. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeBusinessCards.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeBusinessCards))\n", + "- Analyze Invoices: Detects and extracts data from invoices using optical character recognition (OCR) and our invoice understanding deep learning models, enabling you to easily extract structured data from invoices such as customer, vendor, invoice ID, invoice due date, total, invoice amount due, tax amount, ship to, bill to, line items and more. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeInvoices.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeInvoices))\n", + "- Analyze ID Documents: Detects and extracts data from identification documents using optical character recognition (OCR) and our ID document model, enabling you to easily extract structured data from ID documents such as first name, last name, date of birth, document number, and more. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeIDDocuments.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeIDDocuments))\n", + "- Analyze Custom Form: Extracts information from forms (PDFs and images) into structured data based on a model created from a set of representative training forms. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeCustomModel.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeCustomModel))\n", + "- Get Custom Model: Get detailed information about a custom model. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/GetCustomModel.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/ListCustomModels.html))\n", + "- List Custom Models: Get information about all custom models. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/ListCustomModels.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.ListCustomModels))\n", "\n", "### Decision\n", "[**Anomaly Detector**](https://azure.microsoft.com/en-us/services/cognitive-services/anomaly-detector/)\n", - "- Anomaly status of latest point: generates a model using preceding points and determines whether the latest point is anomalous ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/DetectLastAnomaly.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DetectLastAnomaly))\n", - "- Find anomalies: generates a model using an entire series and finds anomalies in the series ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/DetectAnomalies.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DetectAnomalies))\n", + "- Anomaly status of latest point: generates a model using preceding points and determines whether the latest point is anomalous ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DetectLastAnomaly.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DetectLastAnomaly))\n", + "- Find anomalies: generates a model using an entire series and finds anomalies in the series ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DetectAnomalies.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DetectAnomalies))\n", "\n", "### Search\n", - "- [Bing Image search](https://azure.microsoft.com/en-us/services/cognitive-services/bing-image-search-api/) ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/com/microsoft/azure/synapse/ml/cognitive/BingImageSearch.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.BingImageSearch))\n", - "- [Azure Cognitive search](https://docs.microsoft.com/en-us/azure/search/search-what-is-azure-search) ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/index.html#com.microsoft.azure.synapse.ml.cognitive.AzureSearchWriter$), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AzureSearchWriter))\n" + "- [Bing Image search](https://azure.microsoft.com/en-us/services/cognitive-services/bing-image-search-api/) ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/BingImageSearch.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.BingImageSearch))\n", + "- [Azure Cognitive search](https://docs.microsoft.com/en-us/azure/search/search-what-is-azure-search) ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/index.html#com.microsoft.azure.synapse.ml.cognitive.AzureSearchWriter$), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AzureSearchWriter))\n" ], "metadata": {} }, diff --git a/notebooks/features/other/CyberML - Anomalous Access Detection.ipynb b/notebooks/features/other/CyberML - Anomalous Access Detection.ipynb index 2cb553adf1..79811685da 100644 --- a/notebooks/features/other/CyberML - Anomalous Access Detection.ipynb +++ b/notebooks/features/other/CyberML - Anomalous Access Detection.ipynb @@ -34,7 +34,7 @@ "# Create an Azure Databricks cluster and install the following libs\n", "\n", "1. In Cluster Libraries install from library source Maven:\n", - "Coordinates: com.microsoft.azure:synapseml_2.12:0.9.4\n", + "Coordinates: com.microsoft.azure:synapseml_2.12:0.9.5\n", "Repository: https://mmlspark.azureedge.net/maven\n", "\n", "2. In Cluster Libraries install from PyPI the library called plotly" diff --git a/notebooks/features/regression/Regression - Auto Imports.ipynb b/notebooks/features/regression/Regression - Auto Imports.ipynb index b1aac65457..973e934e35 100644 --- a/notebooks/features/regression/Regression - Auto Imports.ipynb +++ b/notebooks/features/regression/Regression - Auto Imports.ipynb @@ -15,15 +15,15 @@ "\n", "This sample demonstrates the use of several members of the synapseml library:\n", "- [`TrainRegressor`\n", - " ](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.train.html?#module-synapse.ml.train.TrainRegressor)\n", + " ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.train.html?#module-synapse.ml.train.TrainRegressor)\n", "- [`SummarizeData`\n", - " ](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.stages.html?#module-synapse.ml.stages.SummarizeData)\n", + " ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.stages.html?#module-synapse.ml.stages.SummarizeData)\n", "- [`CleanMissingData`\n", - " ](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.featurize.html?#module-synapse.ml.featurize.CleanMissingData)\n", + " ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.featurize.html?#module-synapse.ml.featurize.CleanMissingData)\n", "- [`ComputeModelStatistics`\n", - " ](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.train.html?#module-synapse.ml.train.ComputeModelStatistics)\n", + " ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.train.html?#module-synapse.ml.train.ComputeModelStatistics)\n", "- [`FindBestModel`\n", - " ](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.automl.html?#module-synapse.ml.automl.FindBestModel)\n", + " ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.automl.html?#module-synapse.ml.automl.FindBestModel)\n", "\n", "First, import the pandas package so that we can read and parse the datafile\n", "using `pandas.read_csv()`" diff --git a/notebooks/features/regression/Regression - Flight Delays with DataCleaning.ipynb b/notebooks/features/regression/Regression - Flight Delays with DataCleaning.ipynb index 0bab0e1c46..dedd705598 100644 --- a/notebooks/features/regression/Regression - Flight Delays with DataCleaning.ipynb +++ b/notebooks/features/regression/Regression - Flight Delays with DataCleaning.ipynb @@ -16,11 +16,11 @@ "\n", "This sample demonstrates how to use the following APIs:\n", "- [`TrainRegressor`\n", - " ](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.train.html?#module-synapse.ml.train.TrainRegressor)\n", + " ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.train.html?#module-synapse.ml.train.TrainRegressor)\n", "- [`ComputePerInstanceStatistics`\n", - " ](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.train.html?#module-synapse.ml.train.ComputePerInstanceStatistics)\n", + " ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.train.html?#module-synapse.ml.train.ComputePerInstanceStatistics)\n", "- [`DataConversion`\n", - " ](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.featurize.html?#module-synapse.ml.featurize.DataConversion)\n", + " ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.featurize.html?#module-synapse.ml.featurize.DataConversion)\n", "\n", "First, import the pandas package" ] diff --git a/pipeline.yaml b/pipeline.yaml index abef0a34a1..dff2c2fb85 100644 --- a/pipeline.yaml +++ b/pipeline.yaml @@ -63,7 +63,6 @@ jobs: sbt publishSigned sbt genBuildInfo echo "##vso[task.uploadsummary]$(pwd)/target/Build.md" - sbt release displayName: Publish Artifacts env: STORAGE-KEY: $(storage-key) @@ -293,6 +292,20 @@ jobs: PGP-PW: $(pgp-pw) PYPI-API-TOKEN: $(pypi-api-token) displayName: 'publish python package to pypi' + - bash: | + set -e + source activate synapseml + sbt publishSigned + sbt sonatypeBundleRelease + condition: startsWith(variables['tag'], 'v') + env: + STORAGE-KEY: $(storage-key) + NEXUS-UN: $(nexus-un) + NEXUS-PW: $(nexus-pw) + PGP-PRIVATE: $(pgp-private) + PGP-PUBLIC: $(pgp-public) + PGP-PW: $(pgp-pw) + displayName: 'publish jar package to maven central' - job: PythonTests cancelTimeoutInMinutes: 0 diff --git a/website/.gitignore b/website/.gitignore index 9d46e3a639..99b5174260 100644 --- a/website/.gitignore +++ b/website/.gitignore @@ -9,10 +9,23 @@ .cache-loader # Converted markdowns -/docs/examples/* -!/docs/examples/about.md -/docs/features/**/* -!/docs/features/**/about.md +/docs/features/* +!/docs/features/lightgbm +/docs/features/lightgbm/* +!/docs/features/lightgbm/about.md +!/docs/features/onnx +/docs/features/onnx/* +!/docs/features/onnx/about.md +!/docs/features/responsible_ai +/docs/features/responsible_ai/* +!/docs/features/responsible_ai/Data Balance Analysis.md +!/docs/features/responsible_ai/Model Interpretation on Spark.md +!/docs/features/spark_serving +/docs/features/spark_serving/* +!/docs/features/spark_serving/about.md +!/docs/features/vw +/docs/features/vw/* +!/docs/features/vw/about.md # Misc .DS_Store diff --git a/website/docs/about.md b/website/docs/about.md index b8cc6330c8..4488d92a1b 100644 --- a/website/docs/about.md +++ b/website/docs/about.md @@ -25,8 +25,8 @@ sub-millisecond latency web services, backed by your Spark cluster. SynapseML requires Scala 2.12, Spark 3.0+, and Python 3.6+. See the API documentation [for -Scala](https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/index.html#package) and [for -PySpark](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/index.html). +Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/index.html#package) and [for +PySpark](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/index.html). import Link from '@docusaurus/Link'; diff --git a/website/docs/getting_started/installation.md b/website/docs/getting_started/installation.md index d960501b5c..5117936a6d 100644 --- a/website/docs/getting_started/installation.md +++ b/website/docs/getting_started/installation.md @@ -12,7 +12,7 @@ the above example, or from python: ```python import pyspark spark = pyspark.sql.SparkSession.builder.appName("MyApp") \ - .config("spark.jars.packages", "com.microsoft.azure:synapseml_2.12:0.9.4") \ + .config("spark.jars.packages", "com.microsoft.azure:synapseml_2.12:0.9.5") \ .config("spark.jars.repositories", "https://mmlspark.azureedge.net/maven") \ .getOrCreate() import synapse.ml @@ -25,7 +25,7 @@ your `build.sbt`: ```scala resolvers += "SynapseML" at "https://mmlspark.azureedge.net/maven" -libraryDependencies += "com.microsoft.azure" %% "synapseml" % "0.9.4" +libraryDependencies += "com.microsoft.azure" %% "synapseml" % "0.9.5" ``` @@ -35,9 +35,9 @@ SynapseML can be conveniently installed on existing Spark clusters via the `--packages` option, examples: ```bash -spark-shell --packages com.microsoft.azure:synapseml_2.12:0.9.4 -pyspark --packages com.microsoft.azure:synapseml_2.12:0.9.4 -spark-submit --packages com.microsoft.azure:synapseml_2.12:0.9.4 MyApp.jar +spark-shell --packages com.microsoft.azure:synapseml_2.12:0.9.5 +pyspark --packages com.microsoft.azure:synapseml_2.12:0.9.5 +spark-submit --packages com.microsoft.azure:synapseml_2.12:0.9.5 MyApp.jar ``` This can be used in other Spark contexts too. For example, you can use SynapseML @@ -52,7 +52,7 @@ cloud](http://community.cloud.databricks.com), create a new [library from Maven coordinates](https://docs.databricks.com/user-guide/libraries.html#libraries-from-maven-pypi-or-spark-packages) in your workspace. -For the coordinates use: `com.microsoft.azure:synapseml_2.12:0.9.4` +For the coordinates use: `com.microsoft.azure:synapseml_2.12:0.9.5` with the resolver: `https://mmlspark.azureedge.net/maven`. Ensure this library is attached to your target cluster(s). @@ -60,7 +60,7 @@ Finally, ensure that your Spark cluster has at least Spark 3.12 and Scala 2.12. You can use SynapseML in both your Scala and PySpark notebooks. To get started with our example notebooks import the following databricks archive: -`https://mmlspark.blob.core.windows.net/dbcs/SynapseMLExamplesv0.9.4.dbc` +`https://mmlspark.blob.core.windows.net/dbcs/SynapseMLExamplesv0.9.5.dbc` ### Apache Livy and HDInsight @@ -73,8 +73,7 @@ Excluding certain packages from the library may be necessary due to current issu { "name": "synapseml", "conf": { - "spark.jars.packages": "com.microsoft.azure:synapseml_2.12:0.9.4", - "spark.jars.repositories": "https://mmlspark.azureedge.net/maven", + "spark.jars.packages": "com.microsoft.azure:synapseml_2.12:0.9.5", "spark.jars.excludes": "org.scala-lang:scala-reflect,org.apache.spark:spark-tags_2.12,org.scalactic:scalactic_2.12,org.scalatest:scalatest_2.12" } } @@ -87,8 +86,7 @@ In Azure Synapse, "spark.yarn.user.classpath.first" should be set to "true" to o { "name": "synapseml", "conf": { - "spark.jars.packages": "com.microsoft.azure:synapseml_2.12:0.9.4", - "spark.jars.repositories": "https://mmlspark.azureedge.net/maven", + "spark.jars.packages": "com.microsoft.azure:synapseml_2.12:0.9.5", "spark.jars.excludes": "org.scala-lang:scala-reflect,org.apache.spark:spark-tags_2.12,org.scalactic:scalactic_2.12,org.scalatest:scalatest_2.12", "spark.yarn.user.classpath.first": "true" } diff --git a/website/docs/reference/R-setup.md b/website/docs/reference/R-setup.md index 35832fe8a5..60976bbf98 100644 --- a/website/docs/reference/R-setup.md +++ b/website/docs/reference/R-setup.md @@ -18,7 +18,7 @@ To install the current SynapseML package for R use: ```R ... -devtools::install_url("https://mmlspark.azureedge.net/rrr/synapseml-0.9.4.zip") +devtools::install_url("https://mmlspark.azureedge.net/rrr/synapseml-0.9.5.zip") ... ``` @@ -31,7 +31,7 @@ It will take some time to install all dependencies. Then, run: library(sparklyr) library(dplyr) config <- spark_config() -config$sparklyr.defaultPackages <- "com.microsoft.azure:synapseml_2.12:0.9.4" +config$sparklyr.defaultPackages <- "com.microsoft.azure:synapseml_2.12:0.9.5" sc <- spark_connect(master = "local", config = config) ... ``` @@ -91,7 +91,7 @@ and then use spark_connect with method = "databricks": ```R install.packages("devtools") -devtools::install_url("https://mmlspark.azureedge.net/rrr/synapseml-0.9.4.zip") +devtools::install_url("https://mmlspark.azureedge.net/rrr/synapseml-0.9.5.zip") library(sparklyr) library(dplyr) sc <- spark_connect(method = "databricks") diff --git a/website/docs/reference/cyber.md b/website/docs/reference/cyber.md index 74d9a4b053..7f20a17b10 100644 --- a/website/docs/reference/cyber.md +++ b/website/docs/reference/cyber.md @@ -18,50 +18,50 @@ sidebar_label: CyberML (i.e., it returns a sample from the complement set). ## feature engineering: [indexers.py](https://github.com/microsoft/SynapseML/blob/master/core/src/main/python/synapse/ml/cyber/feature/indexers.py) -1. [IdIndexer](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.indexers.IdIndexer) +1. [IdIndexer](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.indexers.IdIndexer) is a SparkML [Estimator](https://spark.apache.org/docs/2.2.0/api/java/index.html?org/apache/spark/ml/Estimator.html). Given a dataframe, it creates an IdIndexerModel (described next) for categorical features which contains the information to map each partition and column seen in the given dataframe to an id. for each partition or one consecutive range for all partition and column values. -2. [IdIndexerModel](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.indexers.IdIndexerModel) +2. [IdIndexerModel](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.indexers.IdIndexerModel) is a SparkML [Transformer](https://spark.apache.org/docs/2.2.0/api/java/index.html?org/apache/spark/ml/Transformer.html). Given a dataframe maps each partition and column field to a consecutive integer id. Partitions or column values not encountered in the estimator are mapped to 0. The model can operate in two modes, either create consecutive integer id independently -3. [MultiIndexer](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.indexers.MultiIndexer) +3. [MultiIndexer](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.indexers.MultiIndexer) is a SparkML [Estimator](https://spark.apache.org/docs/2.2.0/api/java/index.html?org/apache/spark/ml/Estimator.html). Uses multiple IdIndexer to generate a MultiIndexerModel (described next) for categorical features which contains multiple IdIndexers for multiple partitions and columns. -4. [MultiIndexerModel](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.indexers.MultiIndexerModel) +4. [MultiIndexerModel](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.indexers.MultiIndexerModel) is a SparkML [Transformer](https://spark.apache.org/docs/2.2.0/api/java/index.html?org/apache/spark/ml/Transformer.html). Given a dataframe maps each partition and column field to a consecutive integer id. Partitions or column values not encountered in the estimator are mapped to 0. The model can operate in two modes, either create consecutive integer id independently ## feature engineering: [scalers.py](https://github.com/microsoft/SynapseML/blob/master/core/src/main/python/synapse/ml/cyber/feature/scalers.py) -1. [StandardScalarScaler](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.scalers.StandardScalarScaler) +1. [StandardScalarScaler](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.scalers.StandardScalarScaler) is a SparkML [Estimator](https://spark.apache.org/docs/2.2.0/api/java/index.html?org/apache/spark/ml/Estimator.html). Given a dataframe it creates a StandardScalarScalerModel (described next) which normalizes any given dataframe according to the mean and standard deviation calculated on the dataframe given to the estimator. -2. [StandardScalarScalerModel](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.scalers.StandardScalarScalerModel) +2. [StandardScalarScalerModel](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.scalers.StandardScalarScalerModel) is a SparkML [Transformer](https://spark.apache.org/docs/2.2.0/api/java/index.html?org/apache/spark/ml/Transformer.html). Given a dataframe with a value column x, the transformer changes its value as follows: x'=(x-mean)/stddev, i.e., if the transformer is given the same dataframe the estimator was given then the value column will have a mean of 0.0 and a standard deviation of 1.0. -3. [LinearScalarScaler](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.scalers.LinearScalarScaler) +3. [LinearScalarScaler](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.scalers.LinearScalarScaler) is a SparkML [Estimator](https://spark.apache.org/docs/2.2.0/api/java/index.html?org/apache/spark/ml/Estimator.html). Given a dataframe it creates a LinearScalarScalerModel (described next) which normalizes any given dataframe according to the minimum and maximum values calculated on the dataframe given to the estimator. -4. [LinearScalarScalerModel](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.scalers.LinearScalarScalerModel) +4. [LinearScalarScalerModel](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cyber.feature.html#synapse.ml.cyber.feature.scalers.LinearScalarScalerModel) is a SparkML [Transformer](https://spark.apache.org/docs/2.2.0/api/java/index.html?org/apache/spark/ml/Transformer.html). Given a dataframe with a value column x, the transformer changes its value such that if the transformer is given the same dataframe the estimator was given then the value column will be scaled linearly to the given ranges. ## access anomalies: [collaborative_filtering.py](https://github.com/microsoft/SynapseML/blob/master/core/src/main/python/synapse/ml/cyber/anomaly/collaborative_filtering.py) -1. [AccessAnomaly](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cyber.anomaly.html#synapse.ml.cyber.anomaly.collaborative_filtering.AccessAnomaly) +1. [AccessAnomaly](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cyber.anomaly.html#synapse.ml.cyber.anomaly.collaborative_filtering.AccessAnomaly) is a SparkML [Estimator](https://spark.apache.org/docs/2.2.0/api/java/index.html?org/apache/spark/ml/Estimator.html). Given a dataframe the estimator generates an AccessAnomalyModel (next described) which can detect anomalous access of users to resources in such a way where the access @@ -69,14 +69,14 @@ sidebar_label: CyberML a resource from Finance. This is based solely on access patterns rather than explicit features. Internally this is based on Collaborative Filtering as implemented in Spark using Matrix Factorization with Alternating Least Squares. -2. [AccessAnomalyModel](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cyber.anomaly.html#synapse.ml.cyber.anomaly.collaborative_filtering.AccessAnomalyModel) +2. [AccessAnomalyModel](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cyber.anomaly.html#synapse.ml.cyber.anomaly.collaborative_filtering.AccessAnomalyModel) is a SparkML [Transformer](https://spark.apache.org/docs/2.2.0/api/java/index.html?org/apache/spark/ml/Transformer.html). Given a dataframe the transformer computes a value between (-inf, inf) where positive values indicate an anomaly score. Anomaly scores are computed to have a mean of 1.0 and a standard deviation of 1.0 over the original dataframe given to the estimator. -3. [ModelNormalizeTransformer](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cyber.anomaly.html#synapse.ml.cyber.anomaly.collaborative_filtering.ModelNormalizeTransformer) +3. [ModelNormalizeTransformer](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cyber.anomaly.html#synapse.ml.cyber.anomaly.collaborative_filtering.ModelNormalizeTransformer) is a SparkML [Transformer](https://spark.apache.org/docs/2.2.0/api/java/index.html?org/apache/spark/ml/Transformer.html). This is a transformer used internally by AccessAnomaly to normalize a model to generate anomaly scores with mean 0.0 and standard deviation of 1.0. -4. [AccessAnomalyConfig](https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/synapse.ml.cyber.anomaly.html#synapse.ml.cyber.anomaly.collaborative_filtering.AccessAnomalyConfig) +4. [AccessAnomalyConfig](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cyber.anomaly.html#synapse.ml.cyber.anomaly.collaborative_filtering.AccessAnomalyConfig) contains the default values for AccessAnomaly. diff --git a/website/docs/reference/docker.md b/website/docs/reference/docker.md index c83d59ab45..b0a3455e19 100644 --- a/website/docs/reference/docker.md +++ b/website/docs/reference/docker.md @@ -32,7 +32,7 @@ You can now select one of the sample notebooks and run it, or create your own. In the above, `mcr.microsoft.com/mmlspark/release` specifies the project and image name that you want to run. There is another component implicit here which is the _tsag_ (= version) that you want to use — specifying it explicitly looks like -`mcr.microsoft.com/mmlspark/release:0.9.4` for the `0.9.4` tag. +`mcr.microsoft.com/mmlspark/release:0.9.5` for the `0.9.5` tag. Leaving `mcr.microsoft.com/mmlspark/release` by itself has an implicit `latest` tag, so it is equivalent to `mcr.microsoft.com/mmlspark/release:latest`. The `latest` tag is identical to the @@ -48,7 +48,7 @@ that you will probably want to use can look as follows: docker run -it --rm \ -p 127.0.0.1:80:8888 \ -v ~/myfiles:/notebooks/myfiles \ - mcr.microsoft.com/mmlspark/release:0.9.4 + mcr.microsoft.com/mmlspark/release:0.9.5 ``` In this example, backslashes are used to break things up for readability; you @@ -58,7 +58,7 @@ path and line breaks looks a little different: docker run -it --rm ` -p 127.0.0.1:80:8888 ` -v C:\myfiles:/notebooks/myfiles ` - mcr.microsoft.com/mmlspark/release:0.9.4 + mcr.microsoft.com/mmlspark/release:0.9.5 Let's break this command and go over the meaning of each part: @@ -141,7 +141,7 @@ Let's break this command and go over the meaning of each part: model.write().overwrite().save('myfiles/myTrainedModel.mml') ``` -- **`mcr.microsoft.com/mmlspark/release:0.9.4`** +- **`mcr.microsoft.com/mmlspark/release:0.9.5`** Finally, this specifies an explicit version tag for the image that we want to run. diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index b7c63f5004..15be5b531e 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -2,7 +2,7 @@ const math = import('remark-math') const katex = require('rehype-katex') const path = require('path'); const { all_examples } = require('./src/plugins/examples'); -let version = "0.9.4"; +let version = "0.9.5"; module.exports = { title: 'SynapseML', @@ -15,7 +15,7 @@ module.exports = { trailingSlash: true, customFields: { examples: all_examples(), - version: "0.9.4", + version: "0.9.5", }, stylesheets: [ { @@ -89,11 +89,11 @@ module.exports = { }, { label: 'Python API Reference', - to: 'https://mmlspark.blob.core.windows.net/docs/0.9.4/pyspark/index.html', + to: 'https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/index.html', }, { label: 'Scala API Reference', - to: 'https://mmlspark.blob.core.windows.net/docs/0.9.4/scala/index.html', + to: 'https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/index.html', }, ], }, diff --git a/website/package.json b/website/package.json index b36a2fb7c4..cd1219d649 100644 --- a/website/package.json +++ b/website/package.json @@ -15,10 +15,10 @@ "audit:fix": "npx yarn-audit-fix" }, "dependencies": { - "@docusaurus/core": "^2.0.0-beta.9", - "@docusaurus/preset-classic": "^2.0.0-beta.9", - "@docusaurus/theme-classic": "^2.0.0-beta.9", - "@docusaurus/theme-search-algolia": "^2.0.0-beta.9", + "@docusaurus/core": "^2.0.0-beta.14", + "@docusaurus/preset-classic": "^2.0.0-beta.14", + "@docusaurus/theme-classic": "^2.0.0-beta.14", + "@docusaurus/theme-search-algolia": "^2.0.0-beta.14", "ansi-html-community": "^0.0.8", "classnames": "^2.2.6", "hast-util-is-element": "1.1.0", diff --git a/website/src/pages/index.js b/website/src/pages/index.js index 28069ea964..8c698e6385 100644 --- a/website/src/pages/index.js +++ b/website/src/pages/index.js @@ -269,7 +269,7 @@ function Home() { { "name": "synapseml", "conf": { - "spark.jars.packages": "com.microsoft.azure:synapseml_2.12:0.9.4", + "spark.jars.packages": "com.microsoft.azure:synapseml_2.12:0.9.5", "spark.jars.repositories": "https://mmlspark.azureedge.net/maven", "spark.jars.excludes": "org.scala-lang:scala-reflect,org.apache.spark:spark-tags_2.12,org.scalactic:scalactic_2.12,org.scalatest:scalatest_2.12", "spark.yarn.user.classpath.first": "true" @@ -277,7 +277,7 @@ function Home() { }`} lang="bash" > - Please also include `synapseml==0.9.4` in your + Please also include `synapseml==0.9.5` in your requirements.txt file for usage of PySpark. [ Install Python libraries in Synapse @@ -288,9 +288,9 @@ function Home() { SynapseML can be conveniently installed on existing Spark clusters via the --packages option, examples: This can be used in other Spark contexts too. For example, you @@ -317,7 +317,7 @@ spark-submit --packages com.microsoft.azure:synapseml_2.12:0.9.4 MyApp.jar --con

For the coordinates use: with the resolver: @@ -335,7 +335,7 @@ spark-submit --packages com.microsoft.azure:synapseml_2.12:0.9.4 MyApp.jar --con notebooks. To get started with our example notebooks import the following databricks archive: @@ -373,8 +373,7 @@ spark-submit --packages com.microsoft.azure:synapseml_2.12:0.9.4 MyApp.jar --con diff --git a/website/versioned_docs/version-0.9.5/about.md b/website/versioned_docs/version-0.9.5/about.md new file mode 100644 index 0000000000..4488d92a1b --- /dev/null +++ b/website/versioned_docs/version-0.9.5/about.md @@ -0,0 +1,55 @@ +--- +title: SynapseML +sidebar_label: Introduction +hide_title: true +--- + +import useBaseUrl from "@docusaurus/useBaseUrl"; + +

+ +# SynapseML + +SynapseML is an ecosystem of tools aimed towards expanding the distributed computing framework +[Apache Spark](https://github.com/apache/spark) in several new directions. +SynapseML adds many deep learning and data science tools to the Spark ecosystem, +including seamless integration of Spark Machine Learning pipelines with [Microsoft Cognitive Toolkit +(CNTK)](https://github.com/Microsoft/CNTK), [LightGBM](https://github.com/Microsoft/LightGBM) and +[OpenCV](http://www.opencv.org/). These tools enable powerful and highly-scalable predictive and analytical models +for a variety of datasources. + +SynapseML also brings new networking capabilities to the Spark Ecosystem. With the HTTP on Spark project, users +can embed **any** web service into their SparkML models. In this vein, SynapseML provides easy to use +SparkML transformers for a wide variety of [Microsoft Cognitive Services](https://azure.microsoft.com/en-us/services/cognitive-services/). For production grade deployment, the Spark Serving project enables high throughput, +sub-millisecond latency web services, backed by your Spark cluster. + +SynapseML requires Scala 2.12, Spark 3.0+, and Python 3.6+. +See the API documentation [for +Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/index.html#package) and [for +PySpark](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/index.html). + +import Link from '@docusaurus/Link'; + +Get Started + +## Examples + +import NotebookExamples from "@theme/NotebookExamples"; + + + +## Explore our Features + +import FeatureCards from "@theme/FeatureCards"; + + + +## Papers + +- [Large Scale Intelligent Microservices](https://arxiv.org/abs/2009.08044) + +- [Conditional Image Retrieval](https://arxiv.org/abs/2007.07177) + +- [SynapseML: Unifying Machine Learning Ecosystems at Massive Scales](https://arxiv.org/abs/1810.08744) + +- [Flexible and Scalable Deep Learning with MMLSpark](https://arxiv.org/abs/1804.04031) diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/_LightGBM.md b/website/versioned_docs/version-0.9.5/documentation/estimators/_LightGBM.md new file mode 100644 index 0000000000..26fea2654c --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/_LightGBM.md @@ -0,0 +1,166 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## LightGBMClassifier + + + + + + +```python +from synapse.ml.lightgbm import * + +lgbmClassifier = (LightGBMClassifier() + .setFeaturesCol("features") + .setRawPredictionCol("rawPrediction") + .setDefaultListenPort(12402) + .setNumLeaves(5) + .setNumIterations(10) + .setObjective("binary") + .setLabelCol("labels") + .setLeafPredictionCol("leafPrediction") + .setFeaturesShapCol("featuresShap")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.lightgbm._ + +val lgbmClassifier = (new LightGBMClassifier() + .setFeaturesCol("features") + .setRawPredictionCol("rawPrediction") + .setDefaultListenPort(12402) + .setNumLeaves(5) + .setNumIterations(10) + .setObjective("binary") + .setLabelCol("labels") + .setLeafPredictionCol("leafPrediction") + .setFeaturesShapCol("featuresShap")) +``` + + + + + + + +## LightGBMRanker + + + + + + + + + +```python +from synapse.ml.lightgbm import * + +lgbmRanker = (LightGBMRanker() + .setLabelCol("labels") + .setFeaturesCol("features") + .setGroupCol("query") + .setDefaultListenPort(12402) + .setRepartitionByGroupingColumn(False) + .setNumLeaves(5) + .setNumIterations(10)) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.lightgbm._ + +val lgbmRanker = (new LightGBMRanker() + .setLabelCol("labels") + .setFeaturesCol("features") + .setGroupCol("query") + .setDefaultListenPort(12402) + .setRepartitionByGroupingColumn(false) + .setNumLeaves(5) + .setNumIterations(10)) +``` + + + + + + + +## LightGBMRegressor + + + + + + + + + +```python +from synapse.ml.lightgbm import * + +lgbmRegressor = (LightGBMRegressor() + .setLabelCol("labels") + .setFeaturesCol("features") + .setDefaultListenPort(12402) + .setNumLeaves(5) + .setNumIterations(10)) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.lightgbm._ + +val lgbmRegressor = (new LightGBMRegressor() + .setLabelCol("labels") + .setFeaturesCol("features") + .setDefaultListenPort(12402) + .setNumLeaves(5) + .setNumIterations(10)) +``` + + + + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/_VW.md b/website/versioned_docs/version-0.9.5/documentation/estimators/_VW.md new file mode 100644 index 0000000000..ca108aed1a --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/_VW.md @@ -0,0 +1,111 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## VowpalWabbitRegressor + + + + + + +```python +from synapse.ml.vw import * + +vw = (VowpalWabbitRegressor() + .setLabelCol("Y1") + .setFeaturesCol("features") + .setPredictionCol("pred")) + +vwRegressor = (VowpalWabbitRegressor() + .setNumPasses(20) + .setArgs("--holdout_off --loss_function quantile -q :: -l 0.1")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.vw._ + +val vw = (new VowpalWabbitRegressor() + .setLabelCol("Y1") + .setFeaturesCol("features") + .setPredictionCol("pred")) + +val vwRegressor = (new VowpalWabbitRegressor() + .setNumPasses(20) + .setArgs("--holdout_off --loss_function quantile -q :: -l 0.1")) + +``` + + + + + + + +## VowpalWabbitContextualBandit + + + + + + + + + +```python +from synapse.ml.vw import * + +cb = (VowpalWabbitContextualBandit() + .setArgs("--cb_explore_adf --epsilon 0.2 --quiet") + .setLabelCol("cost") + .setProbabilityCol("prob") + .setChosenActionCol("chosen_action") + .setSharedCol("shared_features") + .setFeaturesCol("action_features") + .setUseBarrierExecutionMode(False)) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.vw._ + +val cb = (new VowpalWabbitContextualBandit() + .setArgs("--cb_explore_adf --epsilon 0.2 --quiet") + .setLabelCol("cost") + .setProbabilityCol("prob") + .setChosenActionCol("chosen_action") + .setSharedCol("shared_features") + .setFeaturesCol("action_features") + .setUseBarrierExecutionMode(false)) + +``` + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/cognitive/_MAD.md b/website/versioned_docs/version-0.9.5/documentation/estimators/cognitive/_MAD.md new file mode 100644 index 0000000000..be792f7fdb --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/cognitive/_MAD.md @@ -0,0 +1,107 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## FitMultivariateAnomaly + + + + + + +```python +from synapse.ml.cognitive import * + +anomalyKey = os.environ.get("ANOMALY_API_KEY", getSecret("anomaly-api-key")) +startTime = "2021-01-01T00:00:00Z" +endTime = "2021-01-03T01:59:00Z" +timestampColumn = "timestamp" +inputColumns = ["feature0", "feature1", "feature2"] +containerName = "madtest" +intermediateSaveDir = "intermediateData" +connectionString = os.environ.get("MADTEST_CONNECTION_STRING", getSecret("madtest-connection-string")) + +fitMultivariateAnomaly = (FitMultivariateAnomaly() + .setSubscriptionKey(anomalyKey) + .setLocation("westus2") + .setOutputCol("result") + .setStartTime(startTime) + .setEndTime(endTime) + .setContainerName(containerName) + .setIntermediateSaveDir(intermediateSaveDir) + .setTimestampCol(timestampColumn) + .setInputCols(inputColumns) + .setSlidingWindow(200) + .setConnectionString(connectionString) + .setConcurrency(5)) + +# uncomment below for fitting your own dataframe +# model = fitMultivariateAnomaly.fit(df) +# fitMultivariateAnomaly.cleanUpIntermediateData() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ + +val startTime: String = "2021-01-01T00:00:00Z" +val endTime: String = "2021-01-02T12:00:00Z" +val timestampColumn: String = "timestamp" +val inputColumns: Array[String] = Array("feature0", "feature1", "feature2") +val containerName: String = "madtest" +val intermediateSaveDir: String = "intermediateData" +val anomalyKey = sys.env.getOrElse("ANOMALY_API_KEY", None) +val connectionString = sys.env.getOrElse("MADTEST_CONNECTION_STRING", None) + +val fitMultivariateAnomaly = (new FitMultivariateAnomaly() + .setSubscriptionKey(anomalyKey) + .setLocation("westus2") + .setOutputCol("result") + .setStartTime(startTime) + .setEndTime(endTime) + .setContainerName(containerName) + .setIntermediateSaveDir(intermediateSaveDir) + .setTimestampCol(timestampColumn) + .setInputCols(inputColumns) + .setSlidingWindow(200) + .setConnectionString(connectionString) + .setConcurrency(5)) + +val df = (spark.read.format("csv") + .option("header", True) + .load("wasbs://datasets@mmlspark.blob.core.windows.net/MAD/mad_example.csv")) + +val model = fitMultivariateAnomaly.fit(df) + +val result = (model + .setStartTime(startTime) + .setEndTime(endTime) + .setOutputCol("result") + .setTimestampCol(timestampColumn) + .setInputCols(inputColumns) + .transform(df)) + +result.show() + +fitMultivariateAnomaly.cleanUpIntermediateData() +model.cleanUpIntermediateData() +``` + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/core/_AutoML.md b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_AutoML.md new file mode 100644 index 0000000000..62b47999bd --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_AutoML.md @@ -0,0 +1,213 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + +## AutoML + +### FindBestModel + + + + + + +```python +from synapse.ml.automl import * +from synapse.ml.train import * +from pyspark.ml.classification import RandomForestClassifier + +df = (spark.createDataFrame([ + (0, 2, 0.50, 0.60, 0), + (1, 3, 0.40, 0.50, 1), + (0, 4, 0.78, 0.99, 2), + (1, 5, 0.12, 0.34, 3), + (0, 1, 0.50, 0.60, 0), + (1, 3, 0.40, 0.50, 1), + (0, 3, 0.78, 0.99, 2), + (1, 4, 0.12, 0.34, 3), + (0, 0, 0.50, 0.60, 0), + (1, 2, 0.40, 0.50, 1), + (0, 3, 0.78, 0.99, 2), + (1, 4, 0.12, 0.34, 3) +], ["Label", "col1", "col2", "col3", "col4"])) + +# mocking models +randomForestClassifier = (TrainClassifier() + .setModel(RandomForestClassifier() + .setMaxBins(32) + .setMaxDepth(5) + .setMinInfoGain(0.0) + .setMinInstancesPerNode(1) + .setNumTrees(20) + .setSubsamplingRate(1.0) + .setSeed(0)) + .setFeaturesCol("mlfeatures") + .setLabelCol("Label")) +model = randomForestClassifier.fit(df) + +findBestModel = (FindBestModel() + .setModels([model, model]) + .setEvaluationMetric("accuracy")) +bestModel = findBestModel.fit(df) +bestModel.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.automl._ +import com.microsoft.azure.synapse.ml.train._ +import spark.implicits._ +import org.apache.spark.ml.Transformer + +val df = (Seq( + (0, 2, 0.50, 0.60, 0), + (1, 3, 0.40, 0.50, 1), + (0, 4, 0.78, 0.99, 2), + (1, 5, 0.12, 0.34, 3), + (0, 1, 0.50, 0.60, 0), + (1, 3, 0.40, 0.50, 1), + (0, 3, 0.78, 0.99, 2), + (1, 4, 0.12, 0.34, 3), + (0, 0, 0.50, 0.60, 0), + (1, 2, 0.40, 0.50, 1), + (0, 3, 0.78, 0.99, 2), + (1, 4, 0.12, 0.34, 3) + ).toDF("Label", "col1", "col2", "col3", "col4")) + +// mocking models +val randomForestClassifier = (new TrainClassifier() + .setModel( + new RandomForestClassifier() + .setMaxBins(32) + .setMaxDepth(5) + .setMinInfoGain(0.0) + .setMinInstancesPerNode(1) + .setNumTrees(20) + .setSubsamplingRate(1.0) + .setSeed(0L)) + .setFeaturesCol("mlfeatures") + .setLabelCol("Label")) +val model = randomForestClassifier.fit(df) + +val findBestModel = (new FindBestModel() + .setModels(Array(model.asInstanceOf[Transformer], model.asInstanceOf[Transformer])) + .setEvaluationMetric("accuracy")) +val bestModel = findBestModel.fit(df) +bestModel.transform(df).show() +``` + + + + + + + +### TuneHyperparameters + + + + + + + +```python +from synapse.ml.automl import * +from synapse.ml.train import * +from pyspark.ml.classification import LogisticRegression, RandomForestClassifier, GBTClassifier + + +df = (spark.createDataFrame([ + (0, 1, 1, 1, 1, 1, 1.0, 3, 1, 1), + (0, 1, 1, 1, 1, 2, 1.0, 1, 1, 1), + (0, 1, 1, 1, 1, 2, 1.0, 2, 1, 1), + (0, 1, 2, 3, 1, 2, 1.0, 3, 1, 1), + (0, 3, 1, 1, 1, 2, 1.0, 3, 1, 1) +], ["Label", "Clump_Thickness", "Uniformity_of_Cell_Size", + "Uniformity_of_Cell_Shape", "Marginal_Adhesion", "Single_Epithelial_Cell_Size", + "Bare_Nuclei", "Bland_Chromatin", "Normal_Nucleoli", "Mitoses"])) + +logReg = LogisticRegression() +randForest = RandomForestClassifier() +gbt = GBTClassifier() +smlmodels = [logReg, randForest, gbt] +mmlmodels = [TrainClassifier(model=model, labelCol="Label") for model in smlmodels] + +paramBuilder = (HyperparamBuilder() + .addHyperparam(logReg, logReg.regParam, RangeHyperParam(0.1, 0.3)) + .addHyperparam(randForest, randForest.numTrees, DiscreteHyperParam([5,10])) + .addHyperparam(randForest, randForest.maxDepth, DiscreteHyperParam([3,5])) + .addHyperparam(gbt, gbt.maxBins, RangeHyperParam(8,16)) + .addHyperparam(gbt, gbt.maxDepth, DiscreteHyperParam([3,5]))) +searchSpace = paramBuilder.build() +# The search space is a list of params to tuples of estimator and hyperparam +randomSpace = RandomSpace(searchSpace) + +bestModel = TuneHyperparameters( + evaluationMetric="accuracy", models=mmlmodels, numFolds=2, + numRuns=len(mmlmodels) * 2, parallelism=2, + paramSpace=randomSpace.space(), seed=0).fit(df) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.automl._ +import com.microsoft.azure.synapse.ml.train._ +import spark.implicits._ + +val logReg = new LogisticRegression() +val randForest = new RandomForestClassifier() +val gbt = new GBTClassifier() +val smlmodels = Seq(logReg, randForest, gbt) +val mmlmodels = smlmodels.map(model => new TrainClassifier().setModel(model).setLabelCol("Label")) + +val paramBuilder = new HyperparamBuilder() + .addHyperparam(logReg.regParam, new DoubleRangeHyperParam(0.1, 0.3)) + .addHyperparam(randForest.numTrees, new DiscreteHyperParam(List(5,10))) + .addHyperparam(randForest.maxDepth, new DiscreteHyperParam(List(3,5))) + .addHyperparam(gbt.maxBins, new IntRangeHyperParam(8,16)) +.addHyperparam(gbt.maxDepth, new DiscreteHyperParam(List(3,5))) +val searchSpace = paramBuilder.build() +val randomSpace = new RandomSpace(searchSpace) + +val dataset: DataFrame = Seq( + (0, 1, 1, 1, 1, 1, 1.0, 3, 1, 1), + (0, 1, 1, 1, 1, 2, 1.0, 1, 1, 1), + (0, 1, 1, 1, 1, 2, 1.0, 2, 1, 1), + (0, 1, 2, 3, 1, 2, 1.0, 3, 1, 1), + (0, 3, 1, 1, 1, 2, 1.0, 3, 1, 1)) + .toDF("Label", "Clump_Thickness", "Uniformity_of_Cell_Size", + "Uniformity_of_Cell_Shape", "Marginal_Adhesion", "Single_Epithelial_Cell_Size", + "Bare_Nuclei", "Bland_Chromatin", "Normal_Nucleoli", "Mitoses") + +val tuneHyperparameters = new TuneHyperparameters().setEvaluationMetric("accuracy") + .setModels(mmlmodels.toArray).setNumFolds(2).setNumRuns(mmlmodels.length * 2) + .setParallelism(1).setParamSpace(randomSpace).setSeed(0) +tuneHyperparameters.fit(dataset).show() +``` + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/core/_Featurize.md b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_Featurize.md new file mode 100644 index 0000000000..bf547eb78d --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_Featurize.md @@ -0,0 +1,329 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + +## Featurize + +### CleanMissingData + + + + + + +```python +from synapse.ml.featurize import * + +dataset = spark.createDataFrame([ + (0, 2, 0.50, 0.60, 0), + (1, 3, 0.40, None, None), + (0, 4, 0.78, 0.99, 2), + (1, 5, 0.12, 0.34, 3), + (0, 1, 0.50, 0.60, 0), + (None, None, None, None, None), + (0, 3, 0.78, 0.99, 2), + (1, 4, 0.12, 0.34, 3), + (0, None, 0.50, 0.60, 0), + (1, 2, 0.40, 0.50, None), + (0, 3, None, 0.99, 2), + (1, 4, 0.12, 0.34, 3) +], ["col1", "col2", "col3", "col4", "col5"]) + +cmd = (CleanMissingData() + .setInputCols(dataset.columns) + .setOutputCols(dataset.columns) + .setCleaningMode("Mean")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.featurize._ +import java.lang.{Boolean => JBoolean, Double => JDouble, Integer => JInt} +import spark.implicits._ + +def createMockDataset: DataFrame = { + Seq[(JInt, JInt, JDouble, JDouble, JInt)]( + (0, 2, 0.50, 0.60, 0), + (1, 3, 0.40, null, null), + (0, 4, 0.78, 0.99, 2), + (1, 5, 0.12, 0.34, 3), + (0, 1, 0.50, 0.60, 0), + (null, null, null, null, null), + (0, 3, 0.78, 0.99, 2), + (1, 4, 0.12, 0.34, 3), + (0, null, 0.50, 0.60, 0), + (1, 2, 0.40, 0.50, null), + (0, 3, null, 0.99, 2), + (1, 4, 0.12, 0.34, 3)) + .toDF("col1", "col2", "col3", "col4", "col5") + } + +val dataset = createMockDataset +val cmd = (new CleanMissingData() + .setInputCols(dataset.columns) + .setOutputCols(dataset.columns) + .setCleaningMode("Mean")) +``` + + + + + + + +### CountSelector + + + + + + + + + +```python +from synapse.ml.featurize import * +from pyspark.ml.linalg import Vectors + +df = spark.createDataFrame([ + (Vectors.sparse(3, [(0, 1.0), (2, 2.0)]), Vectors.dense(1.0, 0.1, 0)), + (Vectors.sparse(3, [(0, 1.0), (2, 2.0)]), Vectors.dense(1.0, 0.1, 0)) +], ["col1", "col2"]) + +cs = CountSelector().setInputCol("col1").setOutputCol("col3") + +cs.fit(df).transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.featurize._ +import org.apache.spark.ml.linalg.Vectors +import spark.implicits._ + +val df = Seq( + (Vectors.sparse(3, Seq((0, 1.0), (2, 2.0))), Vectors.dense(1.0, 0.1, 0)), + (Vectors.sparse(3, Seq((0, 1.0), (2, 2.0))), Vectors.dense(1.0, 0.1, 0)) + ).toDF("col1", "col2") + +val cs = (new CountSelector() + .setInputCol("col1") + .setOutputCol("col3")) + +cs.fit(df).transform(df).show() +``` + + + + + + + +### Featurize + + + + + + + + + +```python +from synapse.ml.featurize import * + +dataset = spark.createDataFrame([ + (0, 2, 0.50, 0.60, "pokemon are everywhere"), + (1, 3, 0.40, 0.50, "they are in the woods"), + (0, 4, 0.78, 0.99, "they are in the water"), + (1, 5, 0.12, 0.34, "they are in the fields"), + (0, 3, 0.78, 0.99, "pokemon - gotta catch em all") +], ["Label", "col1", "col2", "col3"]) + +feat = (Featurize() + .setNumFeatures(10) + .setOutputCol("testColumn") + .setInputCols(["col1", "col2", "col3"]) + .setOneHotEncodeCategoricals(False)) + +feat.fit(dataset).transform(dataset).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.featurize._ +import spark.implicits._ + +val dataset = Seq( + (0, 2, 0.50, 0.60, "pokemon are everywhere"), + (1, 3, 0.40, 0.50, "they are in the woods"), + (0, 4, 0.78, 0.99, "they are in the water"), + (1, 5, 0.12, 0.34, "they are in the fields"), + (0, 3, 0.78, 0.99, "pokemon - gotta catch em all")).toDF("Label", "col1", "col2", "col3") + +val featureColumns = dataset.columns.filter(_ != "Label") + +val feat = (new Featurize() + .setNumFeatures(10) + .setOutputCol("testColumn") + .setInputCols(featureColumns) + .setOneHotEncodeCategoricals(false)) + +feat.fit(dataset).transform(dataset).show() +``` + + + + + + + +### ValueIndexer + + + + + + + + + +```python +from synapse.ml.featurize import * + +df = spark.createDataFrame([ + (-3, 24, 0.32534, True, "piano"), + (1, 5, 5.67, False, "piano"), + (-3, 5, 0.32534, False, "guitar") +], ["int", "long", "double", "bool", "string"]) + +vi = ValueIndexer().setInputCol("string").setOutputCol("string_cat") + +vi.fit(df).transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.featurize._ +import spark.implicits._ + +val df = Seq[(Int, Long, Double, Boolean, String)]( + (-3, 24L, 0.32534, true, "piano"), + (1, 5L, 5.67, false, "piano"), + (-3, 5L, 0.32534, false, "guitar")).toDF("int", "long", "double", "bool", "string") + +val vi = new ValueIndexer().setInputCol("string").setOutputCol("string_cat") + +vi.fit(df).transform(df).show() +``` + + + + + + +## Featurize Text + +### TextFeaturizer + + + + + + + + + +```python +from synapse.ml.featurize.text import * + +dfRaw = spark.createDataFrame([ + (0, "Hi I"), + (1, "I wish for snow today"), + (2, "we Cant go to the park, because of the snow!"), + (3, "") +], ["label", "sentence"]) + +tfRaw = (TextFeaturizer() + .setInputCol("sentence") + .setOutputCol("features") + .setNumFeatures(20)) + +tfRaw.fit(dfRaw).transform(dfRaw).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.featurize.text._ +import spark.implicits._ + +val dfRaw = Seq((0, "Hi I"), + (1, "I wish for snow today"), + (2, "we Cant go to the park, because of the snow!"), + (3, "")).toDF("label", "sentence") + +val tfRaw = (new TextFeaturizer() + .setInputCol("sentence") + .setOutputCol("features") + .setNumFeatures(20)) + +tfRaw.fit(dfRaw).transform(dfRaw).show() +``` + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/core/_IsolationForest.md b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_IsolationForest.md new file mode 100644 index 0000000000..c845a16f2d --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_IsolationForest.md @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## Isolation Forest + +### IsolationForest + + + + + + +```python +from synapse.ml.isolationforest import * + +isolationForest = (IsolationForest() + .setNumEstimators(100) + .setBootstrap(False) + .setMaxSamples(256) + .setMaxFeatures(1.0) + .setFeaturesCol("features") + .setPredictionCol("predictedLabel") + .setScoreCol("outlierScore") + .setContamination(0.02) + .setContaminationError(0.02 * 0.01) + .setRandomSeed(1)) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.isolationforest._ +import spark.implicits._ + +val isolationForest = (new IsolationForest() + .setNumEstimators(100) + .setBootstrap(false) + .setMaxSamples(256) + .setMaxFeatures(1.0) + .setFeaturesCol("features") + .setPredictionCol("predictedLabel") + .setScoreCol("outlierScore") + .setContamination(0.02) + .setContaminationError(0.02 * 0.01) + .setRandomSeed(1)) +``` + + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/core/_NN.md b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_NN.md new file mode 100644 index 0000000000..4b917bd8ff --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_NN.md @@ -0,0 +1,93 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## NN + +### ConditionalKNN + + + + + + +```python +from synapse.ml.nn import * + +cknn = (ConditionalKNN() + .setOutputCol("matches") + .setFeaturesCol("features")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.nn._ +import spark.implicits._ + +val cknn = (new ConditionalKNN() + .setOutputCol("matches") + .setFeaturesCol("features")) +``` + + + + + + + +### KNN + + + + + + + + + +```python +from synapse.ml.nn import * + +knn = (KNN() + .setOutputCol("matches")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.nn._ +import spark.implicits._ + +val knn = (new KNN() + .setOutputCol("matches")) +``` + + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/core/_Recommendation.md b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_Recommendation.md new file mode 100644 index 0000000000..a48dbf9ea9 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_Recommendation.md @@ -0,0 +1,375 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## Recommendation + +### RecommendationIndexer, RankingEvaluator, RankingAdapter and RankingTrainValidationSplit + + + + + + +```python +from synapse.ml.recommendation import * +from pyspark.ml.recommendation import ALS +from pyspark.ml.tuning import * + +ratings = (spark.createDataFrame([ + ("11", "Movie 01", 2), + ("11", "Movie 03", 1), + ("11", "Movie 04", 5), + ("11", "Movie 05", 3), + ("11", "Movie 06", 4), + ("11", "Movie 07", 1), + ("11", "Movie 08", 5), + ("11", "Movie 09", 3), + ("22", "Movie 01", 4), + ("22", "Movie 02", 5), + ("22", "Movie 03", 1), + ("22", "Movie 05", 3), + ("22", "Movie 06", 3), + ("22", "Movie 07", 5), + ("22", "Movie 08", 1), + ("22", "Movie 10", 3), + ("33", "Movie 01", 4), + ("33", "Movie 03", 1), + ("33", "Movie 04", 5), + ("33", "Movie 05", 3), + ("33", "Movie 06", 4), + ("33", "Movie 08", 1), + ("33", "Movie 09", 5), + ("33", "Movie 10", 3), + ("44", "Movie 01", 4), + ("44", "Movie 02", 5), + ("44", "Movie 03", 1), + ("44", "Movie 05", 3), + ("44", "Movie 06", 4), + ("44", "Movie 07", 5), + ("44", "Movie 08", 1), + ("44", "Movie 10", 3) + ], ["customerIDOrg", "itemIDOrg", "rating"]) + .dropDuplicates() + .cache()) + +recommendationIndexer = (RecommendationIndexer() + .setUserInputCol("customerIDOrg") + .setUserOutputCol("customerID") + .setItemInputCol("itemIDOrg") + .setItemOutputCol("itemID") + .setRatingCol("rating")) + +transformedDf = (recommendationIndexer.fit(ratings) + .transform(ratings).cache()) + +als = (ALS() + .setNumUserBlocks(1) + .setNumItemBlocks(1) + .setUserCol("customerID") + .setItemCol("itemID") + .setRatingCol("rating") + .setSeed(0)) + +evaluator = (RankingEvaluator() + .setK(3) + .setNItems(10)) + +adapter = (RankingAdapter() + .setK(evaluator.getK()) + .setRecommender(als)) + +adapter.fit(transformedDf).transform(transformedDf).show() + +paramGrid = (ParamGridBuilder() + .addGrid(als.regParam, [1.0]) + .build()) + +tvRecommendationSplit = (RankingTrainValidationSplit() + .setEstimator(als) + .setEvaluator(evaluator) + .setEstimatorParamMaps(paramGrid) + .setTrainRatio(0.8) + .setUserCol(recommendationIndexer.getUserOutputCol()) + .setItemCol(recommendationIndexer.getItemOutputCol()) + .setRatingCol("rating")) + +tvRecommendationSplit.fit(transformedDf).transform(transformedDf).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.recommendation._ +import org.apache.spark.ml.recommendation.ALS +import org.apache.spark.ml.tuning._ +import spark.implicits._ + +val ratings = (Seq( + ("11", "Movie 01", 2), + ("11", "Movie 03", 1), + ("11", "Movie 04", 5), + ("11", "Movie 05", 3), + ("11", "Movie 06", 4), + ("11", "Movie 07", 1), + ("11", "Movie 08", 5), + ("11", "Movie 09", 3), + ("22", "Movie 01", 4), + ("22", "Movie 02", 5), + ("22", "Movie 03", 1), + ("22", "Movie 05", 3), + ("22", "Movie 06", 3), + ("22", "Movie 07", 5), + ("22", "Movie 08", 1), + ("22", "Movie 10", 3), + ("33", "Movie 01", 4), + ("33", "Movie 03", 1), + ("33", "Movie 04", 5), + ("33", "Movie 05", 3), + ("33", "Movie 06", 4), + ("33", "Movie 08", 1), + ("33", "Movie 09", 5), + ("33", "Movie 10", 3), + ("44", "Movie 01", 4), + ("44", "Movie 02", 5), + ("44", "Movie 03", 1), + ("44", "Movie 05", 3), + ("44", "Movie 06", 4), + ("44", "Movie 07", 5), + ("44", "Movie 08", 1), + ("44", "Movie 10", 3)) + .toDF("customerIDOrg", "itemIDOrg", "rating") + .dropDuplicates() + .cache()) + +val recommendationIndexer = (new RecommendationIndexer() + .setUserInputCol("customerIDOrg") + .setUserOutputCol("customerID") + .setItemInputCol("itemIDOrg") + .setItemOutputCol("itemID") + .setRatingCol("rating")) + +val transformedDf = (recommendationIndexer.fit(ratings) + .transform(ratings).cache()) + +val als = (new ALS() + .setNumUserBlocks(1) + .setNumItemBlocks(1) + .setUserCol("customerID") + .setItemCol("itemID") + .setRatingCol("rating") + .setSeed(0)) + +val evaluator = (new RankingEvaluator() + .setK(3) + .setNItems(10)) + +val adapter = (new RankingAdapter() + .setK(evaluator.getK) + .setRecommender(als)) + +adapter.fit(transformedDf).transform(transformedDf).show() + +val paramGrid = (new ParamGridBuilder() + .addGrid(als.regParam, Array(1.0)) + .build()) + +val tvRecommendationSplit = (new RankingTrainValidationSplit() + .setEstimator(als) + .setEvaluator(evaluator) + .setEstimatorParamMaps(paramGrid) + .setTrainRatio(0.8) + .setUserCol(recommendationIndexer.getUserOutputCol) + .setItemCol(recommendationIndexer.getItemOutputCol) + .setRatingCol("rating")) + +tvRecommendationSplit.fit(transformedDf).transform(transformedDf).show() +``` + + + + + + + + + + +### SAR + + + + + + + + + +```python +from synapse.ml.recommendation import * + +ratings = (spark.createDataFrame([ + ("11", "Movie 01", 2), + ("11", "Movie 03", 1), + ("11", "Movie 04", 5), + ("11", "Movie 05", 3), + ("11", "Movie 06", 4), + ("11", "Movie 07", 1), + ("11", "Movie 08", 5), + ("11", "Movie 09", 3), + ("22", "Movie 01", 4), + ("22", "Movie 02", 5), + ("22", "Movie 03", 1), + ("22", "Movie 05", 3), + ("22", "Movie 06", 3), + ("22", "Movie 07", 5), + ("22", "Movie 08", 1), + ("22", "Movie 10", 3), + ("33", "Movie 01", 4), + ("33", "Movie 03", 1), + ("33", "Movie 04", 5), + ("33", "Movie 05", 3), + ("33", "Movie 06", 4), + ("33", "Movie 08", 1), + ("33", "Movie 09", 5), + ("33", "Movie 10", 3), + ("44", "Movie 01", 4), + ("44", "Movie 02", 5), + ("44", "Movie 03", 1), + ("44", "Movie 05", 3), + ("44", "Movie 06", 4), + ("44", "Movie 07", 5), + ("44", "Movie 08", 1), + ("44", "Movie 10", 3) + ], ["customerIDOrg", "itemIDOrg", "rating"]) + .dropDuplicates() + .cache()) + +recommendationIndexer = (RecommendationIndexer() + .setUserInputCol("customerIDOrg") + .setUserOutputCol("customerID") + .setItemInputCol("itemIDOrg") + .setItemOutputCol("itemID") + .setRatingCol("rating")) + +algo = (SAR() + .setUserCol("customerID") + .setItemCol("itemID") + .setRatingCol("rating") + .setTimeCol("timestamp") + .setSupportThreshold(1) + .setSimilarityFunction("jacccard") + .setActivityTimeFormat("EEE MMM dd HH:mm:ss Z yyyy")) + +adapter = (RankingAdapter() + .setK(5) + .setRecommender(algo)) + +res1 = recommendationIndexer.fit(ratings).transform(ratings).cache() + +adapter.fit(res1).transform(res1).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.recommendation._ +import spark.implicits._ + +val ratings = (Seq( + ("11", "Movie 01", 2), + ("11", "Movie 03", 1), + ("11", "Movie 04", 5), + ("11", "Movie 05", 3), + ("11", "Movie 06", 4), + ("11", "Movie 07", 1), + ("11", "Movie 08", 5), + ("11", "Movie 09", 3), + ("22", "Movie 01", 4), + ("22", "Movie 02", 5), + ("22", "Movie 03", 1), + ("22", "Movie 05", 3), + ("22", "Movie 06", 3), + ("22", "Movie 07", 5), + ("22", "Movie 08", 1), + ("22", "Movie 10", 3), + ("33", "Movie 01", 4), + ("33", "Movie 03", 1), + ("33", "Movie 04", 5), + ("33", "Movie 05", 3), + ("33", "Movie 06", 4), + ("33", "Movie 08", 1), + ("33", "Movie 09", 5), + ("33", "Movie 10", 3), + ("44", "Movie 01", 4), + ("44", "Movie 02", 5), + ("44", "Movie 03", 1), + ("44", "Movie 05", 3), + ("44", "Movie 06", 4), + ("44", "Movie 07", 5), + ("44", "Movie 08", 1), + ("44", "Movie 10", 3)) + .toDF("customerIDOrg", "itemIDOrg", "rating") + .dropDuplicates() + .cache()) + +val recommendationIndexer = (new RecommendationIndexer() + .setUserInputCol("customerIDOrg") + .setUserOutputCol("customerID") + .setItemInputCol("itemIDOrg") + .setItemOutputCol("itemID") + .setRatingCol("rating")) + +val algo = (new SAR() + .setUserCol("customerID") + .setItemCol("itemID") + .setRatingCol("rating") + .setTimeCol("timestamp") + .setSupportThreshold(1) + .setSimilarityFunction("jacccard") + .setActivityTimeFormat("EEE MMM dd HH:mm:ss Z yyyy")) + +val adapter = (new RankingAdapter() + .setK(5) + .setRecommender(algo)) + +val res1 = recommendationIndexer.fit(ratings).transform(ratings).cache() + +adapter.fit(res1).transform(res1).show() +``` + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/core/_Stages.md b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_Stages.md new file mode 100644 index 0000000000..ed241a8b8d --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_Stages.md @@ -0,0 +1,220 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## Stages + +### ClassBalancer + + + + + + +```python +from synapse.ml.stages import * + +df = (spark.createDataFrame([ + (0, 1.0, "Hi I"), + (1, 1.0, "I wish for snow today"), + (2, 2.0, "I wish for snow today"), + (3, 2.0, "I wish for snow today"), + (4, 2.0, "I wish for snow today"), + (5, 2.0, "I wish for snow today"), + (6, 0.0, "I wish for snow today"), + (7, 1.0, "I wish for snow today"), + (8, 0.0, "we Cant go to the park, because of the snow!"), + (9, 2.0, "") + ], ["index", "label", "sentence"])) + +cb = ClassBalancer().setInputCol("label") + +cb.fit(df).transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = Seq( + (0, 1.0, "Hi I"), + (1, 1.0, "I wish for snow today"), + (2, 2.0, "I wish for snow today"), + (3, 2.0, "I wish for snow today"), + (4, 2.0, "I wish for snow today"), + (5, 2.0, "I wish for snow today"), + (6, 0.0, "I wish for snow today"), + (7, 1.0, "I wish for snow today"), + (8, 0.0, "we Cant go to the park, because of the snow!"), + (9, 2.0, "")).toDF("index", "label", "sentence") + +val cb = new ClassBalancer().setInputCol("label") + +cb.fit(df).transform(df).show() +``` + + + + + + + +### MultiColumnAdapter + + + + + + + + + +```python +from synapse.ml.stages import * +from pyspark.ml.feature import Tokenizer + +df = (spark.createDataFrame([ + (0, "This is a test", "this is one too"), + (1, "could be a test", "bar"), + (2, "foo", "bar"), + (3, "foo", "maybe not") + ], ["label", "words1", "words2"])) + +stage1 = Tokenizer() +mca = (MultiColumnAdapter() + .setBaseStage(stage1) + .setInputCols(["words1", "words2"]) + .setOutputCols(["output1", "output2"])) + +mca.fit(df).transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ +import org.apache.spark.ml.feature.Tokenizer + +val df = (Seq( + (0, "This is a test", "this is one too"), + (1, "could be a test", "bar"), + (2, "foo", "bar"), + (3, "foo", "maybe not")) + .toDF("label", "words1", "words2")) + +val stage1 = new Tokenizer() +val mca = (new MultiColumnAdapter() + .setBaseStage(stage1) + .setInputCols(Array[String]("words1", "words2")) + .setOutputCols(Array[String]("output1", "output2"))) + +mca.fit(df).transform(df).show() +``` + + + + + + + +### Timer + + + + + + + + + +```python +from synapse.ml.stages import * +from pyspark.ml.feature import * + +df = (spark.createDataFrame([ + (0, "Hi I"), + (1, "I wish for snow today"), + (2, "we Cant go to the park, because of the snow!"), + (3, "") + ], ["label", "sentence"])) + +tok = (Tokenizer() + .setInputCol("sentence") + .setOutputCol("tokens")) + +df2 = Timer().setStage(tok).fit(df).transform(df) + +df3 = HashingTF().setInputCol("tokens").setOutputCol("hash").transform(df2) + +idf = IDF().setInputCol("hash").setOutputCol("idf") +timer = Timer().setStage(idf) + +timer.fit(df3).transform(df3).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ +import org.apache.spark.ml.feature._ + +val df = (Seq( + (0, "Hi I"), + (1, "I wish for snow today"), + (2, "we Cant go to the park, because of the snow!"), + (3, "") + ).toDF("label", "sentence")) + +val tok = (new Tokenizer() + .setInputCol("sentence") + .setOutputCol("tokens")) + +val df2 = new Timer().setStage(tok).fit(df).transform(df) + +val df3 = new HashingTF().setInputCol("tokens").setOutputCol("hash").transform(df2) + +val idf = new IDF().setInputCol("hash").setOutputCol("idf") +val timer = new Timer().setStage(idf) + +timer.fit(df3).transform(df3).show() +``` + + + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/core/_Train.md b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_Train.md new file mode 100644 index 0000000000..0358fc7eac --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/core/_Train.md @@ -0,0 +1,172 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## Train + +### TrainClassifier + + + + + + +```python +from synapse.ml.train import * +from pyspark.ml.classification import LogisticRegression + +df = spark.createDataFrame([ + (0, 2, 0.50, 0.60, 0), + (1, 3, 0.40, 0.50, 1), + (0, 4, 0.78, 0.99, 2), + (1, 5, 0.12, 0.34, 3), + (0, 1, 0.50, 0.60, 0), + (1, 3, 0.40, 0.50, 1), + (0, 3, 0.78, 0.99, 2), + (1, 4, 0.12, 0.34, 3), + (0, 0, 0.50, 0.60, 0), + (1, 2, 0.40, 0.50, 1), + (0, 3, 0.78, 0.99, 2), + (1, 4, 0.12, 0.34, 3)], + ["Label", "col1", "col2", "col3", "col4"] +) + +tc = (TrainClassifier() + .setModel(LogisticRegression()) + .setLabelCol("Label")) + +tc.fit(df).transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.train._ +import org.apache.spark.ml.classification.LogisticRegression + +val df = (Seq( + (0, 2, 0.50, 0.60, 0), + (1, 3, 0.40, 0.50, 1), + (0, 4, 0.78, 0.99, 2), + (1, 5, 0.12, 0.34, 3), + (0, 1, 0.50, 0.60, 0), + (1, 3, 0.40, 0.50, 1), + (0, 3, 0.78, 0.99, 2), + (1, 4, 0.12, 0.34, 3), + (0, 0, 0.50, 0.60, 0), + (1, 2, 0.40, 0.50, 1), + (0, 3, 0.78, 0.99, 2), + (1, 4, 0.12, 0.34, 3)) + .toDF("Label", "col1", "col2", "col3", "col4")) + +val tc = (new TrainClassifier() + .setModel(new LogisticRegression()) + .setLabelCol("Label")) + +tc.fit(df).transform(df).show() +``` + + + + + + + +### TrainRegressor + + + + + + + + + +```python +from synapse.ml.train import * +from pyspark.ml.regression import LinearRegression + +dataset = (spark.createDataFrame([ + (0.0, 2, 0.50, 0.60, 0.0), + (1.0, 3, 0.40, 0.50, 1.0), + (2.0, 4, 0.78, 0.99, 2.0), + (3.0, 5, 0.12, 0.34, 3.0), + (0.0, 1, 0.50, 0.60, 0.0), + (1.0, 3, 0.40, 0.50, 1.0), + (2.0, 3, 0.78, 0.99, 2.0), + (3.0, 4, 0.12, 0.34, 3.0), + (0.0, 0, 0.50, 0.60, 0.0), + (1.0, 2, 0.40, 0.50, 1.0), + (2.0, 3, 0.78, 0.99, 2.0), + (3.0, 4, 0.12, 0.34, 3.0)], + ["label", "col1", "col2", "col3", "col4"])) + +linearRegressor = (LinearRegression() + .setRegParam(0.3) + .setElasticNetParam(0.8)) +trainRegressor = (TrainRegressor() + .setModel(linearRegressor) + .setLabelCol("label")) + +trainRegressor.fit(dataset).transform(dataset).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.train._ +import org.apache.spark.ml.regression.LinearRegression + +val dataset = (spark.createDataFrame(Seq( + (0.0, 2, 0.50, 0.60, 0.0), + (1.0, 3, 0.40, 0.50, 1.0), + (2.0, 4, 0.78, 0.99, 2.0), + (3.0, 5, 0.12, 0.34, 3.0), + (0.0, 1, 0.50, 0.60, 0.0), + (1.0, 3, 0.40, 0.50, 1.0), + (2.0, 3, 0.78, 0.99, 2.0), + (3.0, 4, 0.12, 0.34, 3.0), + (0.0, 0, 0.50, 0.60, 0.0), + (1.0, 2, 0.40, 0.50, 1.0), + (2.0, 3, 0.78, 0.99, 2.0), + (3.0, 4, 0.12, 0.34, 3.0))) + .toDF("label", "col1", "col2", "col3", "col4")) + +val linearRegressor = (new LinearRegression() + .setRegParam(0.3) + .setElasticNetParam(0.8)) +val trainRegressor = (new TrainRegressor() + .setModel(linearRegressor) + .setLabelCol("label")) + +trainRegressor.fit(dataset).transform(dataset).show() +``` + + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/estimators_cognitive.md b/website/versioned_docs/version-0.9.5/documentation/estimators/estimators_cognitive.md new file mode 100644 index 0000000000..e5cd2ef5f2 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/estimators_cognitive.md @@ -0,0 +1,12 @@ +--- +title: Estimators - Cognitive +sidebar_label: Cognitive +hide_title: true +--- + + +import MAD, {toc as MADTOC} from './cognitive/_MAD.md'; + + + +export const toc = [...MADTOC] diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/estimators_core.md b/website/versioned_docs/version-0.9.5/documentation/estimators/estimators_core.md new file mode 100644 index 0000000000..8f32bcfd16 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/estimators_core.md @@ -0,0 +1,42 @@ +--- +title: Estimators - Core +sidebar_label: Core +hide_title: true +--- + + +import AutoML, {toc as AutoMLTOC} from './core/_AutoML.md'; + + + + +import Featurize, {toc as FeaturizeTOC} from './core/_Featurize.md'; + + + + +import IsolationForest, {toc as IsolationForestTOC} from './core/_IsolationForest.md'; + + + + +import NN, {toc as NNTOC} from './core/_NN.md'; + + + + +import Recommendation, {toc as RecommendationTOC} from './core/_Recommendation.md'; + + + + +import Stages, {toc as StagesTOC} from './core/_Stages.md'; + + + +import Train, {toc as TrainTOC} from './core/_Train.md'; + + + +export const toc = [...AutoMLTOC, ...FeaturizeTOC, ...IsolationForestTOC, +...NNTOC, ...RecommendationTOC, ...StagesTOC, ...TrainTOC] diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/estimators_lightgbm.md b/website/versioned_docs/version-0.9.5/documentation/estimators/estimators_lightgbm.md new file mode 100644 index 0000000000..2582e41dc6 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/estimators_lightgbm.md @@ -0,0 +1,13 @@ +--- +title: Estimators - LightGBM +sidebar_label: LightGBM +hide_title: true +--- + +# LightGBM + +import LightGBM, {toc as LightGBMTOC} from './_LightGBM.md'; + + + +export const toc = [...LightGBMTOC] diff --git a/website/versioned_docs/version-0.9.5/documentation/estimators/estimators_vw.md b/website/versioned_docs/version-0.9.5/documentation/estimators/estimators_vw.md new file mode 100644 index 0000000000..80172ac798 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/estimators/estimators_vw.md @@ -0,0 +1,13 @@ +--- +title: Estimators - Vowpal Wabbit +sidebar_label: Vowpal Wabbit +hide_title: true +--- + +# Vowpal Wabbit + +import VW, {toc as VWTOC} from './_VW.md'; + + + +export const toc = [...VWTOC] diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/_OpenCV.md b/website/versioned_docs/version-0.9.5/documentation/transformers/_OpenCV.md new file mode 100644 index 0000000000..5e0513b1b4 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/_OpenCV.md @@ -0,0 +1,121 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## ImageTransformer + + + + + + +```python +from synapse.ml.opencv import * +from pyspark.sql.types import FloatType + +# images = (spark.read.format("image") +# .option("dropInvalid", True) +# .load("wasbs://publicwasb@mmlspark.blob.core.windows.net/explainers/images/david-lusvardi-dWcUncxocQY-unsplash.jpg")) + +it = (ImageTransformer(inputCol="image", outputCol="features") + .resize(224, True) + .centerCrop(height=224, width=224) + .normalize(mean=[0.485, 0.456, 0.406], std=[0.229, 0.224, 0.225], color_scale_factor = 1/255) + .setTensorElementType(FloatType())) + +# it.transform(images).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.opencv._ + +val images = (spark.read.format("image") + .option("dropInvalid", true) + .load("wasbs://publicwasb@mmlspark.blob.core.windows.net/explainers/images/david-lusvardi-dWcUncxocQY-unsplash.jpg")) + +val it = (new ImageTransformer() + .setOutputCol("out") + .resize(height = 15, width = 10)) + +it.transform(images).show() +``` + + + + + + + +## ImageSetAugmenter + + + + + + + + + +```python +from synapse.ml.opencv import * + +# images = (spark.read.format("image") +# .option("dropInvalid", True) +# .load("wasbs://publicwasb@mmlspark.blob.core.windows.net/explainers/images/david-lusvardi-dWcUncxocQY-unsplash.jpg")) + +isa = (ImageSetAugmenter() + .setInputCol("image") + .setOutputCol("augmented") + .setFlipLeftRight(True) + .setFlipUpDown(True)) + +# it.transform(images).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.opencv._ + +val images = (spark.read.format("image") + .option("dropInvalid", true) + .load("wasbs://publicwasb@mmlspark.blob.core.windows.net/explainers/images/david-lusvardi-dWcUncxocQY-unsplash.jpg")) + +val isa = (new ImageSetAugmenter() + .setInputCol("image") + .setOutputCol("augmented") + .setFlipLeftRight(true) + .setFlipUpDown(true)) + +isa.transform(images).show() +``` + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/_VW.md b/website/versioned_docs/version-0.9.5/documentation/transformers/_VW.md new file mode 100644 index 0000000000..d3f2ecc59e --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/_VW.md @@ -0,0 +1,240 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## VectorZipper + + + + + + +```python +from synapse.ml.vw import * + +df = spark.createDataFrame([ + ("action1_f", "action2_f"), + ("action1_f", "action2_f"), + ("action1_f", "action2_f"), + ("action1_f", "action2_f") +], ["action1", "action2"]) + +actionOneFeaturizer = (VowpalWabbitFeaturizer() + .setInputCols(["action1"]) + .setOutputCol("sequence_one")) + +actionTwoFeaturizer = (VowpalWabbitFeaturizer() + .setInputCols(["action2"]) + .setOutputCol("sequence_two")) + +seqDF = actionTwoFeaturizer.transform(actionOneFeaturizer.transform(df)) + +vectorZipper = (VectorZipper() + .setInputCols(["sequence_one", "sequence_two"]) + .setOutputCol("out")) + +vectorZipper.transform(seqDF).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.vw._ + +val df = (Seq( + ("action1_f", "action2_f"), + ("action1_f", "action2_f"), + ("action1_f", "action2_f"), + ("action1_f", "action2_f") + ).toDF("action1", "action2")) + +val actionOneFeaturizer = (new VowpalWabbitFeaturizer() + .setInputCols(Array("action1")) + .setOutputCol("sequence_one")) + +val actionTwoFeaturizer = (new VowpalWabbitFeaturizer() + .setInputCols(Array("action2")) + .setOutputCol("sequence_two")) + +val seqDF = actionTwoFeaturizer.transform(actionOneFeaturizer.transform(df)) + +val vectorZipper = (new VectorZipper() + .setInputCols(Array("sequence_one", "sequence_two")) + .setOutputCol("out")) + +vectorZipper.transform(seqDF).show() +``` + + + + + + + +## VowpalWabbitClassifier + + + + + + + + + + +```python +from synapse.ml.vw import * + +vw = (VowpalWabbitClassifier() + .setNumBits(10) + .setLearningRate(3.1) + .setPowerT(0) + .setLabelConversion(False)) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.vw._ + +val vw = (new VowpalWabbitClassifier() + .setNumBits(10) + .setLearningRate(3.1) + .setPowerT(0) + .setLabelConversion(false)) +``` + + + + + + + +## VowpalWabbitFeaturizer + + + + + + + + + + +```python +from synapse.ml.vw import * + +featurizer = (VowpalWabbitFeaturizer() + .setStringSplitInputCols(["in"]) + .setPreserveOrderNumBits(2) + .setNumBits(18) + .setPrefixStringsWithColumnName(False) + .setOutputCol("features")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.vw._ + +val featurizer = (new VowpalWabbitFeaturizer() + .setStringSplitInputCols(Array("in")) + .setPreserveOrderNumBits(2) + .setNumBits(18) + .setPrefixStringsWithColumnName(false) + .setOutputCol("features")) +``` + + + + + + + +## VowpalWabbitInteractions + + + + + + + + + + +```python +from synapse.ml.vw import * + +interactions = (VowpalWabbitInteractions() + .setInputCols(["v1"]) + .setOutputCol("out")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.vw._ +import org.apache.spark.ml.linalg._ + +case class Data(v1: Vector, v2: Vector, v3: Vector) + +val df = spark.createDataFrame(Seq(Data( + Vectors.dense(Array(1.0, 2.0, 3.0)), + Vectors.sparse(8, Array(5), Array(4.0)), + Vectors.sparse(11, Array(8, 9), Array(7.0, 8.0)) +))) + +val interactions = (new VowpalWabbitInteractions() + .setInputCols(Array("v1")) + .setOutputCol("out")) + +interactions.transform(df).show() +``` + + + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_AnomalyDetection.md b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_AnomalyDetection.md new file mode 100644 index 0000000000..90bb735114 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_AnomalyDetection.md @@ -0,0 +1,316 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## Anomaly Detection + +### DetectLastAnomaly + + + + + + +```python +from synapse.ml.cognitive import * +from pyspark.sql.functions import lit + +anomalyKey = os.environ.get("ANOMALY_API_KEY", getSecret("anomaly-api-key")) +df = (spark.createDataFrame([ + ("1972-01-01T00:00:00Z", 826.0), + ("1972-02-01T00:00:00Z", 799.0), + ("1972-03-01T00:00:00Z", 890.0), + ("1972-04-01T00:00:00Z", 900.0), + ("1972-05-01T00:00:00Z", 766.0), + ("1972-06-01T00:00:00Z", 805.0), + ("1972-07-01T00:00:00Z", 821.0), + ("1972-08-01T00:00:00Z", 20000.0), + ("1972-09-01T00:00:00Z", 883.0), + ("1972-10-01T00:00:00Z", 898.0), + ("1972-11-01T00:00:00Z", 957.0), + ("1972-12-01T00:00:00Z", 924.0), + ("1973-01-01T00:00:00Z", 881.0), + ("1973-02-01T00:00:00Z", 837.0), + ("1973-03-01T00:00:00Z", 90000.0) +], ["timestamp", "value"]) + .withColumn("group", lit(1)) + .withColumn("inputs", struct(col("timestamp"), col("value"))) + .groupBy(col("group")) + .agg(sort_array(collect_list(col("inputs"))).alias("inputs"))) + +dla = (DetectLastAnomaly() + .setSubscriptionKey(anomalyKey) + .setLocation("westus2") + .setOutputCol("anomalies") + .setSeriesCol("inputs") + .setGranularity("monthly") + .setErrorCol("errors")) + +dla.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ +import org.apache.spark.sql.functions.{col, collect_list, lit, sort_array, struct} + +val anomalyKey = sys.env.getOrElse("ANOMALY_API_KEY", None) +val df = (Seq( + ("1972-01-01T00:00:00Z", 826.0), + ("1972-02-01T00:00:00Z", 799.0), + ("1972-03-01T00:00:00Z", 890.0), + ("1972-04-01T00:00:00Z", 900.0), + ("1972-05-01T00:00:00Z", 766.0), + ("1972-06-01T00:00:00Z", 805.0), + ("1972-07-01T00:00:00Z", 821.0), + ("1972-08-01T00:00:00Z", 20000.0), + ("1972-09-01T00:00:00Z", 883.0), + ("1972-10-01T00:00:00Z", 898.0), + ("1972-11-01T00:00:00Z", 957.0), + ("1972-12-01T00:00:00Z", 924.0), + ("1973-01-01T00:00:00Z", 881.0), + ("1973-02-01T00:00:00Z", 837.0), + ("1973-03-01T00:00:00Z", 90000.0) + ).toDF("timestamp","value") + .withColumn("group", lit(1)) + .withColumn("inputs", struct(col("timestamp"), col("value"))) + .groupBy(col("group")) + .agg(sort_array(collect_list(col("inputs"))).alias("inputs"))) + +val dla = (new DetectLastAnomaly() + .setSubscriptionKey(anomalyKey) + .setLocation("westus2") + .setOutputCol("anomalies") + .setSeriesCol("inputs") + .setGranularity("monthly") + .setErrorCol("errors")) + +dla.transform(df).show() +``` + + + + + + +### DetectAnomalies + + + + + + + + + +```python +from synapse.ml.cognitive import * + +anomalyKey = os.environ.get("ANOMALY_API_KEY", getSecret("anomaly-api-key")) +df = (spark.createDataFrame([ + ("1972-01-01T00:00:00Z", 826.0), + ("1972-02-01T00:00:00Z", 799.0), + ("1972-03-01T00:00:00Z", 890.0), + ("1972-04-01T00:00:00Z", 900.0), + ("1972-05-01T00:00:00Z", 766.0), + ("1972-06-01T00:00:00Z", 805.0), + ("1972-07-01T00:00:00Z", 821.0), + ("1972-08-01T00:00:00Z", 20000.0), + ("1972-09-01T00:00:00Z", 883.0), + ("1972-10-01T00:00:00Z", 898.0), + ("1972-11-01T00:00:00Z", 957.0), + ("1972-12-01T00:00:00Z", 924.0), + ("1973-01-01T00:00:00Z", 881.0), + ("1973-02-01T00:00:00Z", 837.0), + ("1973-03-01T00:00:00Z", 90000.0) +], ["timestamp", "value"]) + .withColumn("group", lit(1)) + .withColumn("inputs", struct(col("timestamp"), col("value"))) + .groupBy(col("group")) + .agg(sort_array(collect_list(col("inputs"))).alias("inputs"))) + +da = (DetectAnomalies() + .setSubscriptionKey(anomalyKey) + .setLocation("westus2") + .setOutputCol("anomalies") + .setSeriesCol("inputs") + .setGranularity("monthly")) + +da.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val anomalyKey = sys.env.getOrElse("ANOMALY_API_KEY", None) +val df = (Seq( + ("1972-01-01T00:00:00Z", 826.0), + ("1972-02-01T00:00:00Z", 799.0), + ("1972-03-01T00:00:00Z", 890.0), + ("1972-04-01T00:00:00Z", 900.0), + ("1972-05-01T00:00:00Z", 766.0), + ("1972-06-01T00:00:00Z", 805.0), + ("1972-07-01T00:00:00Z", 821.0), + ("1972-08-01T00:00:00Z", 20000.0), + ("1972-09-01T00:00:00Z", 883.0), + ("1972-10-01T00:00:00Z", 898.0), + ("1972-11-01T00:00:00Z", 957.0), + ("1972-12-01T00:00:00Z", 924.0), + ("1973-01-01T00:00:00Z", 881.0), + ("1973-02-01T00:00:00Z", 837.0), + ("1973-03-01T00:00:00Z", 90000.0) + ).toDF("timestamp","value") + .withColumn("group", lit(1)) + .withColumn("inputs", struct(col("timestamp"), col("value"))) + .groupBy(col("group")) + .agg(sort_array(collect_list(col("inputs"))).alias("inputs"))) + +val da = (new DetectAnomalies() + .setSubscriptionKey(anomalyKey) + .setLocation("westus2") + .setOutputCol("anomalies") + .setSeriesCol("inputs") + .setGranularity("monthly")) + +da.transform(df).show() +``` + + + + + + +### SimpleDetectAnomalies + + + + + + + + + +```python +from synapse.ml.cognitive import * + +anomalyKey = os.environ.get("ANOMALY_API_KEY", getSecret("anomaly-api-key")) +df = (spark.createDataFrame([ + ("1972-01-01T00:00:00Z", 826.0, 1.0), + ("1972-02-01T00:00:00Z", 799.0, 1.0), + ("1972-03-01T00:00:00Z", 890.0, 1.0), + ("1972-04-01T00:00:00Z", 900.0, 1.0), + ("1972-05-01T00:00:00Z", 766.0, 1.0), + ("1972-06-01T00:00:00Z", 805.0, 1.0), + ("1972-07-01T00:00:00Z", 821.0, 1.0), + ("1972-08-01T00:00:00Z", 20000.0, 1.0), + ("1972-09-01T00:00:00Z", 883.0, 1.0), + ("1972-10-01T00:00:00Z", 898.0, 1.0), + ("1972-11-01T00:00:00Z", 957.0, 1.0), + ("1972-12-01T00:00:00Z", 924.0, 1.0), + ("1973-01-01T00:00:00Z", 881.0, 1.0), + ("1973-02-01T00:00:00Z", 837.0, 1.0), + ("1973-03-01T00:00:00Z", 90000.0, 1.0), + ("1972-01-01T00:00:00Z", 826.0, 2.0), + ("1972-02-01T00:00:00Z", 799.0, 2.0), + ("1972-03-01T00:00:00Z", 890.0, 2.0), + ("1972-04-01T00:00:00Z", 900.0, 2.0), + ("1972-05-01T00:00:00Z", 766.0, 2.0), + ("1972-06-01T00:00:00Z", 805.0, 2.0), + ("1972-07-01T00:00:00Z", 821.0, 2.0), + ("1972-08-01T00:00:00Z", 20000.0, 2.0), + ("1972-09-01T00:00:00Z", 883.0, 2.0), + ("1972-10-01T00:00:00Z", 898.0, 2.0), + ("1972-11-01T00:00:00Z", 957.0, 2.0), + ("1972-12-01T00:00:00Z", 924.0, 2.0), + ("1973-01-01T00:00:00Z", 881.0, 2.0), + ("1973-02-01T00:00:00Z", 837.0, 2.0), + ("1973-03-01T00:00:00Z", 90000.0, 2.0) +], ["timestamp", "value", "group"])) + +sda = (SimpleDetectAnomalies() + .setSubscriptionKey(anomalyKey) + .setLocation("westus2") + .setOutputCol("anomalies") + .setGroupbyCol("group") + .setGranularity("monthly")) + +sda.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val anomalyKey = sys.env.getOrElse("ANOMALY_API_KEY", None) +val baseSeq = Seq( + ("1972-01-01T00:00:00Z", 826.0), + ("1972-02-01T00:00:00Z", 799.0), + ("1972-03-01T00:00:00Z", 890.0), + ("1972-04-01T00:00:00Z", 900.0), + ("1972-05-01T00:00:00Z", 766.0), + ("1972-06-01T00:00:00Z", 805.0), + ("1972-07-01T00:00:00Z", 821.0), + ("1972-08-01T00:00:00Z", 20000.0), + ("1972-09-01T00:00:00Z", 883.0), + ("1972-10-01T00:00:00Z", 898.0), + ("1972-11-01T00:00:00Z", 957.0), + ("1972-12-01T00:00:00Z", 924.0), + ("1973-01-01T00:00:00Z", 881.0), + ("1973-02-01T00:00:00Z", 837.0), + ("1973-03-01T00:00:00Z", 9000.0) + ) +val df = (baseSeq.map(p => (p._1,p._2,1.0)) + .++(baseSeq.map(p => (p._1,p._2,2.0))) + .toDF("timestamp","value","group")) + +val sda = (new SimpleDetectAnomalies() + .setSubscriptionKey(anomalyKey) + .setLocation("westus2") + .setOutputCol("anomalies") + .setGroupbyCol("group") + .setGranularity("monthly")) + +sda.transform(df).show() +``` + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_AzureSearch.md b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_AzureSearch.md new file mode 100644 index 0000000000..b485a94e81 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_AzureSearch.md @@ -0,0 +1,152 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + +## Azure Search + +### AzureSearch + + + + + + +```python +from synapse.ml.cognitive import * + +azureSearchKey = os.environ.get("AZURE_SEARCH_KEY", getSecret("azure-search-key")) +testServiceName = "mmlspark-azure-search" + +indexName = "test-website" + +def createSimpleIndexJson(indexName): + json_str = """ + { + "name": "%s", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "key": true, + "facetable": false + }, + { + "name": "fileName", + "type": "Edm.String", + "searchable": false, + "sortable": false, + "facetable": false + }, + { + "name": "text", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + } + ] + } + """ + + return json_str % indexName + +df = (spark.createDataFrame([ + ("upload", "0", "file0", "text0"), + ("upload", "1", "file1", "text1"), + ("upload", "2", "file2", "text2"), + ("upload", "3", "file3", "text3") +], ["searchAction", "id", "fileName", "text"])) + +ad = (AddDocuments() + .setSubscriptionKey(azureSearchKey) + .setServiceName(testServiceName) + .setOutputCol("out") + .setErrorCol("err") + .setIndexName(indexName) + .setActionCol("searchAction")) + +ad.transform(df).show() + +AzureSearchWriter.writeToAzureSearch(df, + subscriptionKey=azureSearchKey, + actionCol="searchAction", + serviceName=testServiceName, + indexJson=createSimpleIndexJson(indexName)) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val azureSearchKey = sys.env.getOrElse("AZURE_SEARCH_KEY", None) +val testServiceName = "mmlspark-azure-search" + +val indexName = "test-website" + +def createSimpleIndexJson(indexName: String) = { + s""" + |{ + | "name": "$indexName", + | "fields": [ + | { + | "name": "id", + | "type": "Edm.String", + | "key": true, + | "facetable": false + | }, + | { + | "name": "fileName", + | "type": "Edm.String", + | "searchable": false, + | "sortable": false, + | "facetable": false + | }, + | { + | "name": "text", + | "type": "Edm.String", + | "filterable": false, + | "sortable": false, + | "facetable": false + | } + | ] + | } + """.stripMargin +} + +val df = ((0 until 4) + .map(i => ("upload", s"$i", s"file$i", s"text$i")) + .toDF("searchAction", "id", "fileName", "text")) + +val ad = (new AddDocuments() + .setSubscriptionKey(azureSearchKey) + .setServiceName(testServiceName) + .setOutputCol("out") + .setErrorCol("err") + .setIndexName(indexName) + .setActionCol("searchAction")) + +ad.transform(df).show() + +AzureSearchWriter.write(df, + Map("subscriptionKey" -> azureSearchKey, + "actionCol" -> "searchAction", + "serviceName" -> testServiceName, + "indexJson" -> createSimpleIndexJson(indexName))) +``` + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_BingImageSearch.md b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_BingImageSearch.md new file mode 100644 index 0000000000..d8703e2335 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_BingImageSearch.md @@ -0,0 +1,94 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + +## Bing Image Search + +### BingImageSearch + + + + + + +```python +from synapse.ml.cognitive import * + +bingSearchKey = os.environ.get("BING_SEARCH_KEY", getSecret("bing-search-key")) + +# Number of images Bing will return per query +imgsPerBatch = 10 +# A list of offsets, used to page into the search results +offsets = [(i*imgsPerBatch,) for i in range(100)] +# Since web content is our data, we create a dataframe with options on that data: offsets +bingParameters = spark.createDataFrame(offsets, ["offset"]) + +# Run the Bing Image Search service with our text query +bingSearch = (BingImageSearch() + .setSubscriptionKey(bingSearchKey) + .setOffsetCol("offset") + .setQuery("Martin Luther King Jr. quotes") + .setCount(imgsPerBatch) + .setOutputCol("images")) + +# Transformer that extracts and flattens the richly structured output of Bing Image Search into a simple URL column +getUrls = BingImageSearch.getUrlTransformer("images", "url") + +# This displays the full results returned +bingSearch.transform(bingParameters).show() + +# Since we have two services, they are put into a pipeline +pipeline = PipelineModel(stages=[bingSearch, getUrls]) + +# Show the results of your search: image URLs +pipeline.transform(bingParameters).show() + +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val bingSearchKey = sys.env.getOrElse("BING_SEARCH_KEY", None) + +// Number of images Bing will return per query +val imgsPerBatch = 10 +// A list of offsets, used to page into the search results +val offsets = (0 until 100).map(i => i*imgsPerBatch) +// Since web content is our data, we create a dataframe with options on that data: offsets +val bingParameters = Seq(offsets).toDF("offset") + +// Run the Bing Image Search service with our text query +val bingSearch = (new BingImageSearch() + .setSubscriptionKey(bingSearchKey) + .setOffsetCol("offset") + .setQuery("Martin Luther King Jr. quotes") + .setCount(imgsPerBatch) + .setOutputCol("images")) + +// Transformer that extracts and flattens the richly structured output of Bing Image Search into a simple URL column +val getUrls = BingImageSearch.getUrlTransformer("images", "url") + +// This displays the full results returned +bingSearch.transform(bingParameters).show() + +// Show the results of your search: image URLs +getUrls.transform(bingSearch.transform(bingParameters)).show() +``` + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_ComputerVision.md b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_ComputerVision.md new file mode 100644 index 0000000000..21af136eb8 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_ComputerVision.md @@ -0,0 +1,542 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## Computer Vision + +### OCR + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) + +df = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/OCR/test1.jpg", ), + ], ["url", ]) + +ocr = (OCR() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setDetectOrientation(True) + .setOutputCol("ocr")) + +ocr.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df = Seq( + "https://mmlspark.blob.core.windows.net/datasets/OCR/test1.jpg" + ).toDF("url") + + +val ocr = (new OCR() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setDetectOrientation(true) + .setOutputCol("ocr")) + +ocr.transform(df).show() +``` + + + + + + + +### AnalyzeImage + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/OCR/test1.jpg", "en"), + ("https://mmlspark.blob.core.windows.net/datasets/OCR/test2.png", None), + ("https://mmlspark.blob.core.windows.net/datasets/OCR/test3.png", "en") + ], ["image", "language"]) + + +ai = (AnalyzeImage() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("image") + .setLanguageCol("language") + .setVisualFeatures(["Categories", "Tags", "Description", "Faces", "ImageType", "Color", "Adult", "Objects", "Brands"]) + .setDetails(["Celebrities", "Landmarks"]) + .setOutputCol("features")) + +ai.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df = Seq( + ("https://mmlspark.blob.core.windows.net/datasets/OCR/test1.jpg", "en"), + ("https://mmlspark.blob.core.windows.net/datasets/OCR/test2.png", null), + ("https://mmlspark.blob.core.windows.net/datasets/OCR/test3.png", "en") + ).toDF("url", "language") + +val ai = (new AnalyzeImage() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setLanguageCol("language") + .setVisualFeatures(Seq("Categories", "Tags", "Description", "Faces", "ImageType", "Color", "Adult", "Objects", "Brands")) + .setDetails(Seq("Celebrities", "Landmarks")) + .setOutputCol("features")) + +ai.transform(df).select("url", "features").show() +``` + + + + + + + +### RecognizeText + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/OCR/test1.jpg", ), + ("https://mmlspark.blob.core.windows.net/datasets/OCR/test2.png", ), + ("https://mmlspark.blob.core.windows.net/datasets/OCR/test3.png", ) + ], ["url", ]) + +rt = (RecognizeText() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setMode("Printed") + .setOutputCol("ocr") + .setConcurrency(5)) + +rt.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df = Seq( + "https://mmlspark.blob.core.windows.net/datasets/OCR/test1.jpg", + "https://mmlspark.blob.core.windows.net/datasets/OCR/test2.png", + "https://mmlspark.blob.core.windows.net/datasets/OCR/test3.png" + ).toDF("url") + +val rt = (new RecognizeText() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setMode("Printed") + .setOutputCol("ocr") + .setConcurrency(5)) + +rt.transform(df).show() +``` + + + + + + + +### ReadImage + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/OCR/test1.jpg", ), + ("https://mmlspark.blob.core.windows.net/datasets/OCR/test2.png", ), + ("https://mmlspark.blob.core.windows.net/datasets/OCR/test3.png", ) + ], ["url", ]) + +ri = (ReadImage() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("ocr") + .setConcurrency(5)) + +ri.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df = Seq( + "https://mmlspark.blob.core.windows.net/datasets/OCR/test1.jpg", + "https://mmlspark.blob.core.windows.net/datasets/OCR/test2.png", + "https://mmlspark.blob.core.windows.net/datasets/OCR/test3.png" + ).toDF("url") + +val ri = (new ReadImage() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("ocr") + .setConcurrency(5)) + +ri.transform(df).show() +``` + + + + + + + +### RecognizeDomainSpecificContent + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test2.jpg", ) + ], ["url", ]) + +celeb = (RecognizeDomainSpecificContent() + .setSubscriptionKey(cognitiveKey) + .setModel("celebrities") + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("celebs")) + +celeb.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df = Seq( + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test2.jpg" + ).toDF("url") + +val celeb = (new RecognizeDomainSpecificContent() + .setSubscriptionKey(cognitiveKey) + .setModel("celebrities") + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("celebs")) + +celeb.transform(df).show() +``` + + + + + + + +### GenerateThumbnails + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg", ) + ], ["url", ]) + +gt = (GenerateThumbnails() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setHeight(50) + .setWidth(50) + .setSmartCropping(True) + .setImageUrlCol("url") + .setOutputCol("thumbnails")) + +gt.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df: DataFrame = Seq( + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg" + ).toDF("url") + +val gt = (new GenerateThumbnails() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setHeight(50) + .setWidth(50) + .setSmartCropping(true) + .setImageUrlCol("url") + .setOutputCol("thumbnails")) + +gt.transform(df).show() +``` + + + + + + + +### TagImage + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg", ) + ], ["url", ]) + +ti = (TagImage() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("tags")) + +ti.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df = Seq( + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg" + ).toDF("url") + +val ti = (new TagImage() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("tags")) + +ti.transform(df).show() +``` + + + + + + + +### DescribeImage + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg", ) + ], ["url", ]) + +di = (DescribeImage() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setMaxCandidates(3) + .setImageUrlCol("url") + .setOutputCol("descriptions")) + +di.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df = Seq( + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg" + ).toDF("url") + +val di = (new DescribeImage() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setMaxCandidates(3) + .setImageUrlCol("url") + .setOutputCol("descriptions")) + +di.transform(df).show() +``` + + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_Face.md b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_Face.md new file mode 100644 index 0000000000..9f8b63930c --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_Face.md @@ -0,0 +1,411 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## Face + +### DetectFace + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg",), +], ["url"]) + +face = (DetectFace() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("detected_faces") + .setReturnFaceId(True) + .setReturnFaceLandmarks(False) + .setReturnFaceAttributes(["age", "gender", "headPose", "smile", "facialHair", "glasses", "emotion", + "hair", "makeup", "occlusion", "accessories", "blur", "exposure", "noise"])) + +face.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df: DataFrame = Seq( + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test2.jpg" + ).toDF("url") + +val face = (new DetectFace() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("face") + .setReturnFaceId(true) + .setReturnFaceLandmarks(true) + .setReturnFaceAttributes(Seq( + "age", "gender", "headPose", "smile", "facialHair", "glasses", "emotion", + "hair", "makeup", "occlusion", "accessories", "blur", "exposure", "noise"))) + +face.transform(df).show() +``` + + + + + + + +### FindSimilarFace + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg",), + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test2.jpg",), + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test3.jpg",) +], ["url"]) + +detector = (DetectFace() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("detected_faces") + .setReturnFaceId(True) + .setReturnFaceLandmarks(False) + .setReturnFaceAttributes([])) + +faceIdDF = detector.transform(df).select("detected_faces").select(col("detected_faces").getItem(0).getItem("faceId").alias("id")) +faceIds = [row.asDict()['id'] for row in faceIdDF.collect()] + +findSimilar = (FindSimilarFace() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setOutputCol("similar") + .setFaceIdCol("id") + .setFaceIds(faceIds)) + +findSimilar.transform(faceIdDF).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df: DataFrame = Seq( + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg", + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test2.jpg", + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test3.jpg" + ).toDF("url") +val detector = (new DetectFace() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("detected_faces") + .setReturnFaceId(true) + .setReturnFaceLandmarks(false) + .setReturnFaceAttributes(Seq())) + +val faceIdDF = (detector.transform(df) + .select(col("detected_faces").getItem(0).getItem("faceId").alias("id")) + .cache()) +val faceIds = faceIdDF.collect().map(row => row.getAs[String]("id")) + +val findSimilar = (new FindSimilarFace() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setOutputCol("similar") + .setFaceIdCol("id") + .setFaceIds(faceIds)) + +findSimilar.transform(faceIdDF).show() +``` + + + + + + + +### GroupFaces + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg",), + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test2.jpg",), + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test3.jpg",) +], ["url"]) + +detector = (DetectFace() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("detected_faces") + .setReturnFaceId(True) + .setReturnFaceLandmarks(False) + .setReturnFaceAttributes([])) + +faceIdDF = detector.transform(df).select("detected_faces").select(col("detected_faces").getItem(0).getItem("faceId").alias("id")) +faceIds = [row.asDict()['id'] for row in faceIdDF.collect()] + +group = (GroupFaces() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setOutputCol("grouping") + .setFaceIds(faceIds)) + +group.transform(faceIdDF).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df: DataFrame = Seq( + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg", + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test2.jpg", + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test3.jpg" + ).toDF("url") +val detector = (new DetectFace() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("detected_faces") + .setReturnFaceId(true) + .setReturnFaceLandmarks(false) + .setReturnFaceAttributes(Seq())) + +val faceIdDF = (detector.transform(df) + .select(col("detected_faces").getItem(0).getItem("faceId").alias("id")) + .cache()) +val faceIds = faceIdDF.collect().map(row => row.getAs[String]("id")) + +val group = (new GroupFaces() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setOutputCol("grouping") + .setFaceIds(faceIds)) + +group.transform(faceIdDF).show() +``` + + + + + + + +### IdentifyFaces + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +pgId = "PUT_YOUR_PERSON_GROUP_ID" + +identifyFaces = (IdentifyFaces() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setFaceIdsCol("faces") + .setPersonGroupId(pgId) + .setOutputCol("identified_faces")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val pgId = "PUT_YOUR_PERSON_GROUP_ID" + +val identifyFaces = (new IdentifyFaces() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setFaceIdsCol("faces") + .setPersonGroupId(pgId) + .setOutputCol("identified_faces")) +``` + + + + + + + +### VerifyFaces + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg",), + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test2.jpg",), + ("https://mmlspark.blob.core.windows.net/datasets/DSIR/test3.jpg",) +], ["url"]) + +detector = (DetectFace() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("detected_faces") + .setReturnFaceId(True) + .setReturnFaceLandmarks(False) + .setReturnFaceAttributes([])) + +faceIdDF = detector.transform(df).select("detected_faces").select(col("detected_faces").getItem(0).getItem("faceId").alias("faceId1")) +faceIdDF2 = faceIdDF.withColumn("faceId2", lit(faceIdDF.take(1)[0].asDict()['faceId1'])) + +verify = (VerifyFaces() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setOutputCol("same") + .setFaceId1Col("faceId1") + .setFaceId2Col("faceId2")) + +verify.transform(faceIdDF2).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df: DataFrame = Seq( + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg", + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test2.jpg", + "https://mmlspark.blob.core.windows.net/datasets/DSIR/test3.jpg" + ).toDF("url") + +val detector = (new DetectFace() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("detected_faces") + .setReturnFaceId(true) + .setReturnFaceLandmarks(false) + .setReturnFaceAttributes(Seq())) + +val faceIdDF = (detector.transform(df) + .select(col("detected_faces").getItem(0).getItem("faceId").alias("faceId1")) + .cache()) +val faceIdDF2 = faceIdDF.withColumn("faceId2", lit(faceIdDF.take(1).head.getString(0))) + +val verify = (new VerifyFaces() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setOutputCol("same") + .setFaceId1Col("faceId1") + .setFaceId2Col("faceId2")) + +verify.transform(faceIdDF2).show() +``` + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_FormRecognizer.md b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_FormRecognizer.md new file mode 100644 index 0000000000..cfe1cc8598 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_FormRecognizer.md @@ -0,0 +1,539 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + +## Form Recognizer + +### AnalyzeLayout + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +imageDf = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/layout1.jpg",) +], ["source",]) + +analyzeLayout = (AnalyzeLayout() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("source") + .setOutputCol("layout") + .setConcurrency(5)) + +(analyzeLayout.transform(imageDf) + .withColumn("lines", flatten(col("layout.analyzeResult.readResults.lines"))) + .withColumn("readLayout", col("lines.text")) + .withColumn("tables", flatten(col("layout.analyzeResult.pageResults.tables"))) + .withColumn("cells", flatten(col("tables.cells"))) + .withColumn("pageLayout", col("cells.text")) + .select("source", "readLayout", "pageLayout")).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val imageDf = Seq( + "https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/layout1.jpg" + ).toDF("source") + +val analyzeLayout = (new AnalyzeLayout() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("source") + .setOutputCol("layout") + .setConcurrency(5)) + +analyzeLayout.transform(imageDf).show() +``` + + + + + + + +### AnalyzeReceipts + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +imageDf = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/receipt1.png",), + ("https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/receipt1.png",) +], ["image",]) + +analyzeReceipts = (AnalyzeReceipts() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("image") + .setOutputCol("receipts") + .setConcurrency(5)) + +analyzeReceipts.transform(imageDf).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val imageDf = Seq( + "https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/receipt1.png", + "https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/receipt1.png" + ).toDF("source") + +val analyzeReceipts = (new AnalyzeReceipts() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("source") + .setOutputCol("receipts") + .setConcurrency(5)) + +analyzeReceipts.transform(imageDf).show() +``` + + + + + + + +### AnalyzeBusinessCards + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +imageDf = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/business_card.jpg",) +], ["source",]) + +analyzeBusinessCards = (AnalyzeBusinessCards() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("source") + .setOutputCol("businessCards") + .setConcurrency(5)) + +analyzeBusinessCards.transform(imageDf).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val imageDf = Seq( + "https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/business_card.jpg" + ).toDF("source") + +val analyzeBusinessCards = (new AnalyzeBusinessCards() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("source") + .setOutputCol("businessCards") + .setConcurrency(5)) + +analyzeBusinessCards.transform(imageDf).show() +``` + + + + + + + +### AnalyzeInvoices + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +imageDf = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/invoice2.png",) +], ["source",]) + +analyzeInvoices = (AnalyzeInvoices() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("source") + .setOutputCol("invoices") + .setConcurrency(5)) + +(analyzeInvoices + .transform(imageDf) + .withColumn("documents", explode(col("invoices.analyzeResult.documentResults.fields"))) + .select("source", "documents")).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val imageDf = Seq( + "https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/invoice2.png" + ).toDF("source") + +val analyzeInvoices = (new AnalyzeInvoices() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("source") + .setOutputCol("invoices") + .setConcurrency(5)) + +analyzeInvoices.transform(imageD4).show() +``` + + + + + + + +### AnalyzeIDDocuments + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +imageDf = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/id1.jpg",) +], ["source",]) + +analyzeIDDocuments = (AnalyzeIDDocuments() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("source") + .setOutputCol("ids") + .setConcurrency(5)) + +(analyzeIDDocuments + .transform(imageDf) + .withColumn("documents", explode(col("ids.analyzeResult.documentResults.fields"))) + .select("source", "documents")).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val imageDf = Seq( + "https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/id1.jpg" + ).toDF("source") + +val analyzeIDDocuments = (new AnalyzeIDDocuments() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setImageUrlCol("source") + .setOutputCol("ids") + .setConcurrency(5)) + +analyzeIDDocuments.transform(imageDf).show() +``` + + + + + + + +### AnalyzeCustomModel + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +modelId = "02bc2f58-2beb-4ae3-84fb-08f011b2f7b8" # put your own modelId here +imageDf = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/invoice2.png",) +], ["source",]) + +analyzeCustomModel = (AnalyzeCustomModel() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setModelId(modelId) + .setImageUrlCol("source") + .setOutputCol("output") + .setConcurrency(5)) + +(analyzeCustomModel + .transform(imageDf) + .withColumn("keyValuePairs", flatten(col("output.analyzeResult.pageResults.keyValuePairs"))) + .withColumn("keys", col("keyValuePairs.key.text")) + .withColumn("values", col("keyValuePairs.value.text")) + .withColumn("keyValuePairs", create_map(lit("key"), col("keys"), lit("value"), col("values"))) + .select("source", "keyValuePairs")).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val modelId = "02bc2f58-2beb-4ae3-84fb-08f011b2f7b8" // put your own modelId here +val imageDf = Seq( + "https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/invoice2.png" + ).toDF("source") + +val analyzeCustomModel = (new AnalyzeCustomModel() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setModelId(modelId) + .setImageUrlCol("source") + .setOutputCol("output") + .setConcurrency(5)) + +analyzeCustomModel.transform(imageDf).show() +``` + + + + + + + +### GetCustomModel + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +modelId = "02bc2f58-2beb-4ae3-84fb-08f011b2f7b8" # put your own modelId here +emptyDf = spark.createDataFrame([("",)]) + +getCustomModel = (GetCustomModel() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setModelId(modelId) + .setIncludeKeys(True) + .setOutputCol("model") + .setConcurrency(5)) + +(getCustomModel + .transform(emptyDf) + .withColumn("modelInfo", col("model.ModelInfo")) + .withColumn("trainResult", col("model.TrainResult")) + .select("modelInfo", "trainResult")).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val modelId = "02bc2f58-2beb-4ae3-84fb-08f011b2f7b8" // put your own modelId here +val emptyDf = Seq("").toDF() + +val getCustomModel = (new GetCustomModel() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setModelId(modelId) + .setIncludeKeys(true) + .setOutputCol("model") + .setConcurrency(5)) + +getCustomModel.transform(emptyDf).show() +``` + + + + + + + +### ListCustomModels + + + + + + + + + +```python +from synapse.ml.cognitive import * + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +emptyDf = spark.createDataFrame([("",)]) + +listCustomModels = (ListCustomModels() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setOp("full") + .setOutputCol("models") + .setConcurrency(5)) + +(listCustomModels + .transform(emptyDf) + .withColumn("modelIds", col("models.modelList.modelId")) + .select("modelIds")).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val emptyDf = Seq("").toDF() + +val listCustomModels = (new ListCustomModels() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setOp("full") + .setOutputCol("models") + .setConcurrency(5)) + +listCustomModels.transform(emptyDf).show() +``` + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_SpeechToText.md b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_SpeechToText.md new file mode 100644 index 0000000000..87f8c41425 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_SpeechToText.md @@ -0,0 +1,143 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + +## Speech To Text + +### SpeechToText + + + + + + +```python +from synapse.ml.cognitive import * +import requests + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +link = "https://mmlspark.blob.core.windows.net/datasets/Speech/audio2.wav" +audioBytes = requests.get(link).content +df = spark.createDataFrame([(audioBytes,) + ], ["audio"]) + +stt = (SpeechToText() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setOutputCol("text") + .setAudioDataCol("audio") + .setLanguage("en-US") + .setFormat("simple")) + +stt.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ +import org.apache.commons.compress.utils.IOUtils +import java.net.URL + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val audioBytes = IOUtils.toByteArray(new URL("https://mmlspark.blob.core.windows.net/datasets/Speech/test1.wav").openStream()) + +val df: DataFrame = Seq( + Tuple1(audioBytes) + ).toDF("audio") + +val stt = (new SpeechToText() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setOutputCol("text") + .setAudioDataCol("audio") + .setLanguage("en-US") + .setFormat("simple")) + +stt.transform(df).show() +``` + + + + + + + +### SpeechToTextSDK + + + + + + + + + +```python +from synapse.ml.cognitive import * +import requests + +cognitiveKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([("https://mmlspark.blob.core.windows.net/datasets/Speech/audio2.wav",) + ], ["url"]) + +speech_to_text = (SpeechToTextSDK() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setOutputCol("text") + .setAudioDataCol("url") + .setLanguage("en-US") + .setProfanity("Masked")) + +speech_to_text.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ +import org.apache.commons.compress.utils.IOUtils +import java.net.URL + +val cognitiveKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df: DataFrame = Seq( + "https://mmlspark.blob.core.windows.net/datasets/Speech/audio2.wav" + ).toDF("url") + +val speech_to_text = (new SpeechToTextSDK() + .setSubscriptionKey(cognitiveKey) + .setLocation("eastus") + .setOutputCol("text") + .setAudioDataCol("url") + .setLanguage("en-US") + .setProfanity("Masked")) + +speech_to_text.transform(df).show() +``` + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_TextAnalytics.md b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_TextAnalytics.md new file mode 100644 index 0000000000..d1939c56a5 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_TextAnalytics.md @@ -0,0 +1,412 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + +## Text Analytics + +### EntityDetector + + + + + + +```python +from synapse.ml.cognitive import * + +textKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("1", "Microsoft released Windows 10"), + ("2", "In 1975, Bill Gates III and Paul Allen founded the company.") +], ["id", "text"]) + +entity = (EntityDetector() + .setSubscriptionKey(textKey) + .setLocation("eastus") + .setLanguage("en") + .setOutputCol("replies") + .setErrorCol("error")) + +entity.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ +import org.apache.spark.sql.functions.{col, flatten} + +val textKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df = Seq( + ("1", "Microsoft released Windows 10"), + ("2", "In 1975, Bill Gates III and Paul Allen founded the company.") + ).toDF("id", "text") + +val entity = (new EntityDetector() + .setSubscriptionKey(textKey) + .setLocation("eastus") + .setLanguage("en") + .setOutputCol("replies")) + +entity.transform(df).show() +``` + + + + + + + +### KeyPhraseExtractor + + + + + + + +```python +from synapse.ml.cognitive import * + +textKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("en", "Hello world. This is some input text that I love."), + ("fr", "Bonjour tout le monde"), + ("es", "La carretera estaba atascada. Había mucho tráfico el día de ayer.") +], ["lang", "text"]) + +keyPhrase = (KeyPhraseExtractor() + .setSubscriptionKey(textKey) + .setLocation("eastus") + .setLanguageCol("lang") + .setOutputCol("replies") + .setErrorCol("error")) + +keyPhrase.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val textKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df = Seq( + ("en", "Hello world. This is some input text that I love."), + ("fr", "Bonjour tout le monde"), + ("es", "La carretera estaba atascada. Había mucho tráfico el día de ayer."), + ("en", null) + ).toDF("lang", "text") + +val keyPhrase = (new KeyPhraseExtractor() + .setSubscriptionKey(textKey) + .setLocation("eastus") + .setLanguageCol("lang") + .setOutputCol("replies")) + +keyPhrase.transform(df).show() +``` + + + + + + + +### LanguageDetector + + + + + + + + + +```python +from synapse.ml.cognitive import * + +textKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("Hello World",), + ("Bonjour tout le monde",), + ("La carretera estaba atascada. Había mucho tráfico el día de ayer.",), + ("你好",), + ("こんにちは",), + (":) :( :D",) +], ["text",]) + +language = (LanguageDetector() + .setSubscriptionKey(textKey) + .setLocation("eastus") + .setTextCol("text") + .setOutputCol("language") + .setErrorCol("error")) + +language.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val textKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df = Seq( + "Hello World", + "Bonjour tout le monde", + "La carretera estaba atascada. Había mucho tráfico el día de ayer.", + ":) :( :D" + ).toDF("text") + +val language = (new LanguageDetector() + .setSubscriptionKey(textKey) + .setLocation("eastus") + .setOutputCol("replies")) + +language.transform(df).show() +``` + + + + + + + +### NER + + + + + + + + + +```python +from synapse.ml.cognitive import * + +textKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("1", "en", "I had a wonderful trip to Seattle last week."), + ("2", "en", "I visited Space Needle 2 times.") +], ["id", "language", "text"]) + +ner = (NER() + .setSubscriptionKey(textKey) + .setLocation("eastus") + .setLanguageCol("language") + .setOutputCol("replies") + .setErrorCol("error")) + +ner.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val textKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df = Seq( + ("1", "en", "I had a wonderful trip to Seattle last week."), + ("2", "en", "I visited Space Needle 2 times.") + ).toDF("id", "language", "text") + +val ner = (new NER() + .setSubscriptionKey(textKey) + .setLocation("eastus") + .setLanguage("en") + .setOutputCol("response")) + +ner.transform(df).show() +``` + + + + + + + +### PII + + + + + + + + + +```python +from synapse.ml.cognitive import * + +textKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("1", "en", "My SSN is 859-98-0987"), + ("2", "en", + "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."), + ("3", "en", "Is 998.214.865-68 your Brazilian CPF number?") +], ["id", "language", "text"]) + +pii = (PII() + .setSubscriptionKey(textKey) + .setLocation("eastus") + .setLanguage("en") + .setOutputCol("response")) + +pii.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val textKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df = Seq( + ("1", "en", "My SSN is 859-98-0987"), + ("2", "en", + "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."), + ("3", "en", "Is 998.214.865-68 your Brazilian CPF number?") + ).toDF("id", "language", "text") + +val pii = (new PII() + .setSubscriptionKey(textKey) + .setLocation("eastus") + .setLanguage("en") + .setOutputCol("response")) + +pii.transform(df).show() +``` + + + + + + + +### TextSentiment + + + + + + + + + +```python +from synapse.ml.cognitive import * + +textKey = os.environ.get("COGNITIVE_API_KEY", getSecret("cognitive-api-key")) +df = spark.createDataFrame([ + ("I am so happy today, its sunny!", "en-US"), + ("I am frustrated by this rush hour traffic", "en-US"), + ("The cognitive services on spark aint bad", "en-US"), +], ["text", "language"]) + +sentiment = (TextSentiment() + .setSubscriptionKey(textKey) + .setLocation("eastus") + .setTextCol("text") + .setOutputCol("sentiment") + .setErrorCol("error") + .setLanguageCol("language")) + +sentiment.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val textKey = sys.env.getOrElse("COGNITIVE_API_KEY", None) +val df = Seq( + ("en", "Hello world. This is some input text that I love."), + ("fr", "Bonjour tout le monde"), + ("es", "La carretera estaba atascada. Había mucho tráfico el día de ayer."), + (null, "ich bin ein berliner"), + (null, null), + ("en", null) + ).toDF("lang", "text") + +val sentiment = (new TextSentiment() + .setSubscriptionKey(textKey) + .setLocation("eastus") + .setLanguageCol("lang") + .setModelVersion("latest") + .setShowStats(true) + .setOutputCol("replies")) + +sentiment.transform(df).show() +``` + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_Translator.md b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_Translator.md new file mode 100644 index 0000000000..9232004342 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/cognitive/_Translator.md @@ -0,0 +1,484 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + +## Translator + +### Translate + + + + + + +```python +from synapse.ml.cognitive import * + +translatorKey = os.environ.get("TRANSLATOR_KEY", getSecret("translator-key")) +df = spark.createDataFrame([ + (["Hello, what is your name?", "Bye"],) +], ["text",]) + +translate = (Translate() + .setSubscriptionKey(translatorKey) + .setLocation("eastus") + .setTextCol("text") + .setToLanguage(["zh-Hans", "fr"]) + .setOutputCol("translation") + .setConcurrency(5)) + +(translate + .transform(df) + .withColumn("translation", flatten(col("translation.translations"))) + .withColumn("translation", col("translation.text")) + .select("translation")).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ +import org.apache.spark.sql.functions.{col, flatten} + +val translatorKey = sys.env.getOrElse("TRANSLATOR_KEY", None) +val df = Seq(List("Hello, what is your name?", "Bye")).toDF("text") + +val translate = (new Translate() + .setSubscriptionKey(translatorKey) + .setLocation("eastus") + .setTextCol("text") + .setToLanguage(Seq("zh-Hans", "fr")) + .setOutputCol("translation") + .setConcurrency(5)) + +(translate + .transform(df) + .withColumn("translation", flatten(col("translation.translations"))) + .withColumn("translation", col("translation.text")) + .select("translation")).show() +``` + + + + + + + +### Transliterate + + + + + + + + + +```python +from synapse.ml.cognitive import * + +translatorKey = os.environ.get("TRANSLATOR_KEY", getSecret("translator-key")) +df = spark.createDataFrame([ + (["こんにちは", "さようなら"],) +], ["text",]) + +transliterate = (Transliterate() + .setSubscriptionKey(translatorKey) + .setLocation("eastus") + .setLanguage("ja") + .setFromScript("Jpan") + .setToScript("Latn") + .setTextCol("text") + .setOutputCol("result")) + +(transliterate + .transform(df) + .withColumn("text", col("result.text")) + .withColumn("script", col("result.script")) + .select("text", "script")).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ +import org.apache.spark.sql.functions.col + +val translatorKey = sys.env.getOrElse("TRANSLATOR_KEY", None) +val df = Seq(List("こんにちは", "さようなら")).toDF("text") + +val transliterate = (new Transliterate() + .setSubscriptionKey(translatorKey) + .setLocation("eastus") + .setLanguage("ja") + .setFromScript("Jpan") + .setToScript("Latn") + .setTextCol("text") + .setOutputCol("result")) + +(transliterate + .transform(df) + .withColumn("text", col("result.text")) + .withColumn("script", col("result.script")) + .select("text", "script")).show() +``` + + + + + + + +### Detect + + + + + + + + + +```python +from synapse.ml.cognitive import * + +translatorKey = os.environ.get("TRANSLATOR_KEY", getSecret("translator-key")) +df = spark.createDataFrame([ + (["Hello, what is your name?"],) +], ["text",]) + +detect = (Detect() + .setSubscriptionKey(translatorKey) + .setLocation("eastus") + .setTextCol("text") + .setOutputCol("result")) + +(detect + .transform(df) + .withColumn("language", col("result.language")) + .select("language")).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ +import org.apache.spark.sql.functions.col + +val translatorKey = sys.env.getOrElse("TRANSLATOR_KEY", None) +val df = Seq(List("Hello, what is your name?")).toDF("text") + +val detect = (new Detect() + .setSubscriptionKey(translatorKey) + .setLocation("eastus") + .setTextCol("text") + .setOutputCol("result")) + +(detect + .transform(df) + .withColumn("language", col("result.language")) + .select("language")).show() +``` + + + + + + + +### BreakSentence + + + + + + + + + +```python +from synapse.ml.cognitive import * + +translatorKey = os.environ.get("TRANSLATOR_KEY", getSecret("translator-key")) +df = spark.createDataFrame([ + (["Hello, what is your name?"],) +], ["text",]) + +breakSentence = (BreakSentence() + .setSubscriptionKey(translatorKey) + .setLocation("eastus") + .setTextCol("text") + .setOutputCol("result")) + +(breakSentence + .transform(df) + .withColumn("sentLen", flatten(col("result.sentLen"))) + .select("sentLen")).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ +import org.apache.spark.sql.functions.{col, flatten} + +val translatorKey = sys.env.getOrElse("TRANSLATOR_KEY", None) +val df = Seq(List("Hello, what is your name?")).toDF("text") + +val breakSentence = (new BreakSentence() + .setSubscriptionKey(translatorKey) + .setLocation("eastus") + .setTextCol("text") + .setOutputCol("result")) + +(breakSentence + .transform(df) + .withColumn("sentLen", flatten(col("result.sentLen"))) + .select("sentLen")).show() +``` + + + + + + + +### DictionaryLookup + + + + + + + + + +```python +from synapse.ml.cognitive import * + +translatorKey = os.environ.get("TRANSLATOR_KEY", getSecret("translator-key")) +df = spark.createDataFrame([ + (["fly"],) +], ["text",]) + +dictionaryLookup = (DictionaryLookup() + .setSubscriptionKey(translatorKey) + .setLocation("eastus") + .setFromLanguage("en") + .setToLanguage("es") + .setTextCol("text") + .setOutputCol("result")) + +(dictionaryLookup + .transform(df) + .withColumn("translations", flatten(col("result.translations"))) + .withColumn("normalizedTarget", col("translations.normalizedTarget")) + .select("normalizedTarget")).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ +import org.apache.spark.sql.functions.{col, flatten} + +val translatorKey = sys.env.getOrElse("TRANSLATOR_KEY", None) +val df = Seq(List("fly")).toDF("text") + +val dictionaryLookup = (new DictionaryLookup() + .setSubscriptionKey(translatorKey) + .setLocation("eastus") + .setFromLanguage("en") + .setToLanguage("es") + .setTextCol("text") + .setOutputCol("result")) + +(dictionaryLookup + .transform(df) + .withColumn("translations", flatten(col("result.translations"))) + .withColumn("normalizedTarget", col("translations.normalizedTarget")) + .select("normalizedTarget")).show() +``` + + + + + + + +### DictionaryExamples + + + + + + + + + +```python +from synapse.ml.cognitive import * + +translatorKey = os.environ.get("TRANSLATOR_KEY", getSecret("translator-key")) +df = spark.createDataFrame([ + ([("fly", "volar")],) +], ["textAndTranslation",]) + +dictionaryExamples = (DictionaryExamples() + .setSubscriptionKey(translatorKey) + .setLocation("eastus") + .setFromLanguage("en") + .setToLanguage("es") + .setTextAndTranslationCol("textAndTranslation") + .setOutputCol("result")) + +(dictionaryExamples + .transform(df) + .withColumn("examples", flatten(col("result.examples"))) + .select("examples")).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ +import org.apache.spark.sql.functions.{col, flatten} + +val translatorKey = sys.env.getOrElse("TRANSLATOR_KEY", None) +val df = Seq(List(("fly", "volar"))).toDF("textAndTranslation") + +val dictionaryExamples = (new DictionaryExamples() + .setSubscriptionKey(translatorKey) + .setLocation("eastus") + .setFromLanguage("en") + .setToLanguage("es") + .setTextAndTranslationCol("textAndTranslation") + .setOutputCol("result")) + +(dictionaryExamples + .transform(df) + .withColumn("examples", flatten(col("result.examples"))) + .select("examples")).show() +``` + + + + + + + +### DocumentTranslator + + + + + + + + + +```python +from synapse.ml.cognitive import * + +translatorKey = os.environ.get("TRANSLATOR_KEY", getSecret("translator-key")) +translatorName = os.environ.get("TRANSLATOR_NAME", "mmlspark-translator") + +documentTranslator = (DocumentTranslator() + .setSubscriptionKey(translatorKey) + .setServiceName(translatorName) + .setSourceUrlCol("sourceUrl") + .setTargetsCol("targets") + .setOutputCol("translationStatus")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.cognitive._ +import spark.implicits._ + +val translatorKey = sys.env.getOrElse("TRANSLATOR_KEY", None) +val translatorName = sys.env.getOrElse("TRANSLATOR_NAME", None) + +val documentTranslator = (new DocumentTranslator() + .setSubscriptionKey(translatorKey) + .setServiceName(translatorName) + .setSourceUrlCol("sourceUrl") + .setTargetsCol("targets") + .setOutputCol("translationStatus")) +``` + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Explainers.md b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Explainers.md new file mode 100644 index 0000000000..0c90b2b4c7 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Explainers.md @@ -0,0 +1,569 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## Explainers + +### ImageLIME + + + + + + +```python +from synapse.ml.explainers import * +from synapse.ml.onnx import ONNXModel + +model = ONNXModel() + +lime = (ImageLIME() + .setModel(model) + .setOutputCol("weights") + .setInputCol("image") + .setCellSize(150.0) + .setModifier(50.0) + .setNumSamples(500) + .setTargetCol("probability") + .setTargetClassesCol("top2pred") + .setSamplingFraction(0.7)) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.explainers._ +import com.microsoft.azure.synapse.ml.onnx._ +import spark.implicits._ + +val model = (new ONNXModel()) + +val lime = (new ImageLIME() + .setModel(model) + .setOutputCol("weights") + .setInputCol("image") + .setCellSize(150.0) + .setModifier(50.0) + .setNumSamples(500) + .setTargetCol("probability") + .setTargetClassesCol("top2pred") + .setSamplingFraction(0.7)) +``` + + + + + + + +### ImageSHAP + + + + + + + + + +```python +from synapse.ml.explainers import * +from synapse.ml.onnx import ONNXModel + +model = ONNXModel() + +shap = ( + ImageSHAP() + .setModel(model) + .setOutputCol("shaps") + .setSuperpixelCol("superpixels") + .setInputCol("image") + .setCellSize(150.0) + .setModifier(50.0) + .setNumSamples(500) + .setTargetCol("probability") + .setTargetClassesCol("top2pred") +) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.explainers._ +import com.microsoft.azure.synapse.ml.onnx._ +import spark.implicits._ + +val model = (new ONNXModel()) + +val shap = (new ImageSHAP() + .setModel(model) + .setOutputCol("shaps") + .setSuperpixelCol("superpixels") + .setInputCol("image") + .setCellSize(150.0) + .setModifier(50.0) + .setNumSamples(500) + .setTargetCol("probability") + .setTargetClassesCol("top2pred") +)) +``` + + + + + + + +### TabularLIME + + + + + + + + + +```python +from synapse.ml.explainers import * +from synapse.ml.onnx import ONNXModel + +model = ONNXModel() +data = spark.createDataFrame([ + (-6.0, 0), + (-5.0, 0), + (5.0, 1), + (6.0, 1) +], ["col1", "label"]) + +lime = (TabularLIME() + .setModel(model) + .setInputCols(["col1"]) + .setOutputCol("weights") + .setBackgroundData(data) + .setKernelWidth(0.001) + .setNumSamples(1000) + .setTargetCol("probability") + .setTargetClasses([0, 1])) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.explainers._ +import com.microsoft.azure.synapse.ml.onnx._ +import spark.implicits._ + +val model = (new ONNXModel()) +val data = Seq( + (-6.0, 0), + (-5.0, 0), + (5.0, 1), + (6.0, 1) +).toDF("col1", "label") + +val lime = (new TabularLIME() + .setInputCols(Array("col1")) + .setOutputCol("weights") + .setBackgroundData(data) + .setKernelWidth(0.001) + .setNumSamples(1000) + .setModel(model) + .setTargetCol("probability") + .setTargetClasses(Array(0, 1))) +``` + + + + + + + +### TabularSHAP + + + + + + + + + +```python +from synapse.ml.explainers import * +from synapse.ml.onnx import ONNXModel + +model = ONNXModel() +data = spark.createDataFrame([ + (-5.0, "a", -5.0, 0), + (-5.0, "b", -5.0, 0), + (5.0, "a", 5.0, 1), + (5.0, "b", 5.0, 1) +]*100, ["col1", "label"]) + +shap = (TabularSHAP() + .setInputCols(["col1", "col2", "col3"]) + .setOutputCol("shapValues") + .setBackgroundData(data) + .setNumSamples(1000) + .setModel(model) + .setTargetCol("probability") + .setTargetClasses([1])) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.explainers._ +import com.microsoft.azure.synapse.ml.onnx._ +import spark.implicits._ + +val model = (new ONNXModel()) +val data = (1 to 100).flatMap(_ => Seq( + (-5d, "a", -5d, 0), + (-5d, "b", -5d, 0), + (5d, "a", 5d, 1), + (5d, "b", 5d, 1) + )).toDF("col1", "col2", "col3", "label") + +val shap = (new TabularSHAP() + .setInputCols(Array("col1", "col2", "col3")) + .setOutputCol("shapValues") + .setBackgroundData(data) + .setNumSamples(1000) + .setModel(model) + .setTargetCol("probability") + .setTargetClasses(Array(1))) +``` + + + + + + + +### TextLIME + + + + + + + + + +```python +from synapse.ml.explainers import * +from synapse.ml.onnx import ONNXModel + +model = ONNXModel() + +lime = (TextLIME() + .setModel(model) + .setInputCol("text") + .setTargetCol("prob") + .setTargetClasses([1]) + .setOutputCol("weights") + .setTokensCol("tokens") + .setSamplingFraction(0.7) + .setNumSamples(1000)) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.explainers._ +import com.microsoft.azure.synapse.ml.onnx._ +import spark.implicits._ + +val model = (new ONNXModel()) + +val lime = (new TextLIME() + .setModel(model) + .setInputCol("text") + .setTargetCol("prob") + .setTargetClasses(Array(1)) + .setOutputCol("weights") + .setTokensCol("tokens") + .setSamplingFraction(0.7) + .setNumSamples(1000)) +``` + + + + + + + +### TextSHAP + + + + + + + + + +```python +from synapse.ml.explainers import * +from synapse.ml.onnx import ONNXModel + +model = ONNXModel() + +shap = (TextSHAP() + .setModel(model) + .setInputCol("text") + .setTargetCol("prob") + .setTargetClasses([1]) + .setOutputCol("weights") + .setTokensCol("tokens") + .setNumSamples(1000)) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.explainers._ +import com.microsoft.azure.synapse.ml.onnx._ +import spark.implicits._ + +val model = (new ONNXModel()) + +val shap = (new TextSHAP() + .setModel(model) + .setInputCol("text") + .setTargetCol("prob") + .setTargetClasses(Array(1)) + .setOutputCol("weights") + .setTokensCol("tokens") + .setNumSamples(1000)) +``` + + + + + + + +### VectorLIME + + + + + + + + + +```python +from synapse.ml.explainers import * +from synapse.ml.onnx import ONNXModel + +model = ONNXModel() + +df = spark.createDataFrame([ + ([0.2729799734928408, -0.4637273304253777, 1.565593782147994], 4.541185129673482), + ([1.9511879801376864, 1.495644437589599, -0.4667847796501322], 0.19526424470709836) +]) + +lime = (VectorLIME() + .setModel(model) + .setBackgroundData(df) + .setInputCol("features") + .setTargetCol("label") + .setOutputCol("weights") + .setNumSamples(1000)) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.explainers._ +import spark.implicits._ +import breeze.linalg.{*, DenseMatrix => BDM} +import breeze.stats.distributions.Rand +import org.apache.spark.ml.linalg.Vectors +import org.apache.spark.ml.regression.LinearRegression + +val d1 = 3 +val d2 = 1 +val coefficients: BDM[Double] = new BDM(d1, d2, Array(1.0, -1.0, 2.0)) + +val df = { + val nRows = 100 + val intercept: Double = math.random() + + val x: BDM[Double] = BDM.rand(nRows, d1, Rand.gaussian) + val y = x * coefficients + intercept + + val xRows = x(*, ::).iterator.toSeq.map(dv => Vectors.dense(dv.toArray)) + val yRows = y(*, ::).iterator.toSeq.map(dv => dv(0)) + xRows.zip(yRows).toDF("features", "label") + } + +val model: LinearRegressionModel = new LinearRegression().fit(df) + +val lime = (new VectorLIME() + .setModel(model) + .setBackgroundData(df) + .setInputCol("features") + .setTargetCol(model.getPredictionCol) + .setOutputCol("weights") + .setNumSamples(1000)) +``` + + + + + + + +### VectorSHAP + + + + + + + + + +```python +from synapse.ml.explainers import * +from synapse.ml.onnx import ONNXModel + +model = ONNXModel() + +shap = (VectorSHAP() + .setInputCol("features") + .setOutputCol("shapValues") + .setNumSamples(1000) + .setModel(model) + .setTargetCol("probability") + .setTargetClasses([1])) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.explainers._ +import spark.implicits._ +import breeze.linalg.{*, DenseMatrix => BDM} +import breeze.stats.distributions.RandBasis +import org.apache.spark.ml.classification.LogisticRegression +import org.apache.spark.ml.linalg.Vectors + +val randBasis = RandBasis.withSeed(123) +val m: BDM[Double] = BDM.rand[Double](1000, 5, randBasis.gaussian) +val l: BDV[Double] = m(*, ::).map { + row => + if (row(2) + row(3) > 0.5) 1d else 0d + } +val data = m(*, ::).iterator.zip(l.valuesIterator).map { + case (f, l) => (f.toSpark, l) + }.toSeq.toDF("features", "label") + +val model = new LogisticRegression() + .setFeaturesCol("features") + .setLabelCol("label") + .fit(data) + +val shap = (new VectorSHAP() + .setInputCol("features") + .setOutputCol("shapValues") + .setBackgroundData(data) + .setNumSamples(1000) + .setModel(model) + .setTargetCol("probability") + .setTargetClasses(Array(1)) + +val infer = Seq( + Tuple1(Vectors.dense(1d, 1d, 1d, 1d, 1d)) + ) toDF "features" +val predicted = model.transform(infer) +shap.transform(predicted).show() +``` + + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Featurize.md b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Featurize.md new file mode 100644 index 0000000000..f8a67c8258 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Featurize.md @@ -0,0 +1,280 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## Featurize + +### DataConversion + + + + + + +```python +from synapse.ml.featurize import * + +df = spark.createDataFrame([ + (True, 1, 2, 3, 4, 5.0, 6.0, "7", "8.0"), + (False, 9, 10, 11, 12, 14.5, 15.5, "16", "17.456"), + (True, -127, 345, 666, 1234, 18.91, 20.21, "100", "200.12345") +], ["bool", "byte", "short", "int", "long", "float", "double", "intstring", "doublestring"]) + +dc = (DataConversion() + .setCols(["byte"]) + .setConvertTo("boolean")) + +dc.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.featurize._ +import spark.implicits._ + +val df = Seq( + (true: Boolean, 1: Byte, 2: Short, 3: Integer, 4: Long, 5.0F, 6.0, "7", "8.0"), + (false, 9: Byte, 10: Short, 11: Integer, 12: Long, 14.5F, 15.5, "16", "17.456"), + (true, -127: Byte, 345: Short, Short.MaxValue + 100, (Int.MaxValue).toLong + 100, 18.91F, 20.21, "100", "200.12345")) + .toDF("bool", "byte", "short", "int", "long", "float", "double", "intstring", "doublestring") + +val dc = (new DataConversion() + .setCols(Array("byte")) + .setConvertTo("boolean")) + +dc.transform(df).show() +``` + + + + + + + +### IndexToValue + + + + + + + + + +```python +from synapse.ml.featurize import * + +df = spark.createDataFrame([ + (-3, 24, 0.32534, True, "piano"), + (1, 5, 5.67, False, "piano"), + (-3, 5, 0.32534, False, "guitar") +], ["int", "long", "double", "bool", "string"]) + +df2 = ValueIndexer().setInputCol("string").setOutputCol("string_cat").fit(df).transform(df) + +itv = (IndexToValue() + .setInputCol("string_cat") + .setOutputCol("string_noncat")) + +itv.transform(df2).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.featurize._ +import spark.implicits._ + +val df = Seq[(Int, Long, Double, Boolean, String)]( + (-3, 24L, 0.32534, true, "piano"), + (1, 5L, 5.67, false, "piano"), + (-3, 5L, 0.32534, false, "guitar")).toDF("int", "long", "double", "bool", "string") + +val df2 = new ValueIndexer().setInputCol("string").setOutputCol("string_cat").fit(df).transform(df) + +val itv = (new IndexToValue() + .setInputCol("string_cat") + .setOutputCol("string_noncat")) + +itv.transform(df2).show() +``` + + + + + + + +## Featurize Text + +### MultiNGram + + + + + + + + + +```python +from synapse.ml.featurize.text import * +from pyspark.ml.feature import Tokenizer + +dfRaw = spark.createDataFrame([ + (0, "Hi I"), + (1, "I wish for snow today"), + (2, "we Cant go to the park, because of the snow!"), + (3, ""), + (4, "1 2 3 4 5 6 7 8 9") +], ["label", "sentence"]) + +dfTok = (Tokenizer() + .setInputCol("sentence") + .setOutputCol("tokens") + .transform(dfRaw)) + +mng = (MultiNGram() + .setLengths([1, 3, 4]) + .setInputCol("tokens") + .setOutputCol("ngrams")) + +mng.transform(dfTok).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.featurize.text._ +import org.apache.spark.ml.feature.Tokenizer +import spark.implicits._ + +val dfRaw = (Seq( + (0, "Hi I"), + (1, "I wish for snow today"), + (2, "we Cant go to the park, because of the snow!"), + (3, ""), + (4, (1 to 10).map(_.toString).mkString(" "))) + .toDF("label", "sentence")) + +val dfTok = (new Tokenizer() + .setInputCol("sentence") + .setOutputCol("tokens") + .transform(dfRaw)) + +val mng = (new MultiNGram() + .setLengths(Array(1, 3, 4)) + .setInputCol("tokens") + .setOutputCol("ngrams")) + +mng.transform(dfTok).show() +``` + + + + + + + +### PageSplitter + + + + + + + + + +```python +from synapse.ml.featurize.text import * + +df = spark.createDataFrame([ + ("words words words wornssaa ehewjkdiw weijnsikjn xnh", ), + ("s s s s s s", ), + ("hsjbhjhnskjhndwjnbvckjbnwkjwenbvfkjhbnwevkjhbnwejhkbnvjkhnbndjkbnd", ), + ("hsjbhjhnskjhndwjnbvckjbnwkjwenbvfkjhbnwevkjhbnwejhkbnvjkhnbndjkbnd 190872340870271091309831097813097130i3u709781", ), + ("", ), + (None, ) +], ["text"]) + +ps = (PageSplitter() + .setInputCol("text") + .setMaximumPageLength(20) + .setMinimumPageLength(10) + .setOutputCol("pages")) + +ps.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.featurize.text._ +import spark.implicits._ + +val df = Seq( + "words words words wornssaa ehewjkdiw weijnsikjn xnh", + "s s s s s s", + "hsjbhjhnskjhndwjnbvckjbnwkjwenbvfkjhbnwevkjhbnwejhkbnvjkhnbndjkbnd", + "hsjbhjhnskjhndwjnbvckjbnwkjwenbvfkjhbnwevkjhbnwejhkbnvjkhnbndjkbnd " + + "190872340870271091309831097813097130i3u709781", + "", + null + ).toDF("text") + +val ps = (new PageSplitter() + .setInputCol("text") + .setMaximumPageLength(20) + .setMinimumPageLength(10) + .setOutputCol("pages")) + +ps.transform(df).show() +``` + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/core/_IO.md b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_IO.md new file mode 100644 index 0000000000..45f42bc3e6 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_IO.md @@ -0,0 +1,340 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## IO + +### HTTPTransformer + + + + + + +```python +from synapse.ml.io.http import * +from pyspark.sql.functions import udf, col +from requests import Request + +def world_bank_request(country): + return Request("GET", "http://api.worldbank.org/v2/country/{}?format=json".format(country)) + +df = (spark.createDataFrame([("br",), ("usa",)], ["country"]) + .withColumn("request", http_udf(world_bank_request)(col("country")))) + +ht = (HTTPTransformer() + .setConcurrency(3) + .setInputCol("request") + .setOutputCol("response")) + +ht.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.io.http._ + +val ht = (new HTTPTransformer() + .setConcurrency(3) + .setInputCol("request") + .setOutputCol("response")) +``` + + + + + + + +### SimpleHTTPTransformer + + + + + + + + + +```python +from synapse.ml.io.http import * +from pyspark.sql.types import StringType, StructType + +sht = (SimpleHTTPTransformer() + .setInputCol("data") + .setOutputParser(JSONOutputParser() + .setDataType(StructType().add("blah", StringType()))) + .setUrl("PUT_YOUR_URL") + .setOutputCol("results") + .setConcurrency(3)) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.io.http._ +import org.apache.spark.sql.types.{StringType, StructType} + +val sht = (new SimpleHTTPTransformer() + .setInputCol("data") + .setOutputParser(new JSONOutputParser() + .setDataType(new StructType().add("blah", StringType))) + .setUrl("PUT_YOUR_URL") + .setOutputCol("results") + .setConcurrency(3)) +``` + + + + + + + +### JSONInputParser + + + + + + + + + +```python +from synapse.ml.io.http import * + +jsonIP = (JSONInputParser() + .setInputCol("data") + .setOutputCol("out") + .setUrl("PUT_YOUR_URL")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.io.http._ + +val jsonIP = (new JSONInputParser() + .setInputCol("data") + .setOutputCol("out") + .setUrl("PUT_YOUR_URL")) +``` + + + + + + + +### JSONOutputParser + + + + + + + + + +```python +from synapse.ml.io.http import * +from pyspark.sql.types import StringType, StructType + +jsonOP = (JSONOutputParser() + .setDataType(StructType().add("foo", StringType())) + .setInputCol("unparsedOutput") + .setOutputCol("parsedOutput")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.io.http._ +import org.apache.spark.sql.types.{StringType, StructType} + +val jsonOP = (new JSONOutputParser() + .setDataType(new StructType().add("foo", StringType)) + .setInputCol("unparsedOutput") + .setOutputCol("parsedOutput")) +``` + + + + + + + +### StringOutputParser + + + + + + + + + +```python +from synapse.ml.io.http import * + +sop = (StringOutputParser() + .setInputCol("unparsedOutput") + .setOutputCol("out")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.io.http._ + +val sop = (new StringOutputParser() + .setInputCol("unparsedOutput") + .setOutputCol("out")) +``` + + + + + + + +### CustomInputParser + + + + + + + + + +```python +from synapse.ml.io.http import * + +cip = (CustomInputParser() + .setInputCol("data") + .setOutputCol("out")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.io.http._ + +val cip = (new CustomInputParser() + .setInputCol("data") + .setOutputCol("out") + .setUDF({ x: Int => new HttpPost(s"http://$x") })) +``` + + + + + + + +### CustomOutputParser + + + + + + + + + +```python +from synapse.ml.io.http import * + +cop = (CustomOutputParser() + .setInputCol("unparsedOutput") + .setOutputCol("out")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.io.http._ + +val cop = (new CustomOutputParser() + .setInputCol("unparsedOutput") + .setOutputCol("out")) +``` + + + + + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Image.md b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Image.md new file mode 100644 index 0000000000..8329a06dff --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Image.md @@ -0,0 +1,180 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## Image + +### ResizeImageTransformer + + + + + + +```python +from synapse.ml.image import * + +# images = (spark.read.format("image") +# .option("dropInvalid", True) +# .load("wasbs://datasets@mmlspark.blob.core.windows.net/LIME/greyscale.jpg")) + +rit = (ResizeImageTransformer() + .setOutputCol("out") + .setHeight(15) + .setWidth(10)) + +# rit.transform(images).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.image._ +import spark.implicits._ + +// val images = (spark.read.format("image") +// .option("dropInvalid", true) +// .load("wasbs://datasets@mmlspark.blob.core.windows.net/LIME/greyscale.jpg")) + +val rit = (new ResizeImageTransformer() + .setOutputCol("out") + .setHeight(15) + .setWidth(10)) + +// rit.transform(images).show() +``` + + + + + + + +### UnrollImage + + + + + + + + + +```python +from synapse.ml.image import * +from azure.storage.blob import * + +# images = (spark.read.format("image") +# .option("dropInvalid", True) +# .load("wasbs://datasets@mmlspark.blob.core.windows.net/LIME/greyscale.jpg")) + +# rit = (ResizeImageTransformer() +# .setOutputCol("out") +# .setHeight(15) +# .setWidth(10)) + +# preprocessed = rit.transform(images) + +unroll = (UnrollImage() + .setInputCol("out") + .setOutputCol("final")) + +# unroll.transform(preprocessed).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.image._ +import spark.implicits._ + +val images = (spark.read.format("image") + .option("dropInvalid", true) + .load("wasbs://datasets@mmlspark.blob.core.windows.net/LIME/greyscale.jpg")) + +val rit = (new ResizeImageTransformer() + .setOutputCol("out") + .setHeight(15) + .setWidth(10)) + +val preprocessed = rit.transform(images) + +val unroll = (new UnrollImage() + .setInputCol(rit.getOutputCol) + .setOutputCol("final")) + +unroll.transform(preprocessed).show() +``` + + + + + + + +### UnrollBinaryImage + + + + + + + + + +```python +from synapse.ml.image import * + +unroll = (UnrollBinaryImage() + .setInputCol("input_col") + .setOutputCol("final")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.image._ +import spark.implicits._ + +val unroll = (new UnrollBinaryImage() + .setInputCol("input_col") + .setOutputCol("final")) + +``` + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Stages.md b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Stages.md new file mode 100644 index 0000000000..a3e74c97b4 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Stages.md @@ -0,0 +1,1026 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## Stages + +### Cacher + + + + + + +```python +from synapse.ml.stages import * + +df = (spark.createDataFrame([ + (0, "guitars", "drums"), + (1, "piano", "trumpet"), + (2, "bass", "cymbals"), + (3, "guitars", "drums"), + (4, "piano", "trumpet"), + (5, "bass", "cymbals"), + (6, "guitars", "drums"), + (7, "piano", "trumpet"), + (8, "bass", "cymbals"), + (9, "guitars", "drums"), + (10, "piano", "trumpet"), + (11, "bass", "cymbals") + ], ["numbers", "words", "more"])) + +cacher = Cacher() + +cacher.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = Seq( + (0, "guitars", "drums"), + (1, "piano", "trumpet"), + (2, "bass", "cymbals"), + (3, "guitars", "drums"), + (4, "piano", "trumpet"), + (5, "bass", "cymbals"), + (6, "guitars", "drums"), + (7, "piano", "trumpet"), + (8, "bass", "cymbals"), + (9, "guitars", "drums"), + (10, "piano", "trumpet"), + (11, "bass", "cymbals") + ).toDF("numbers", "words", "more") + +val cacher = new Cacher() + +cacher.transform(df).show() +``` + + + + + + + +### DropColumns + + + + + + + + + +```python +from synapse.ml.stages import * + +df = (spark.createDataFrame([ + (0, 0, "guitars", "drums", 1, True), + (1, 1, "piano", "trumpet", 2, False), + (2, 2, "bass", "cymbals", 3, True) + ], ["numbers", "doubles", "words", "more", "longs", "booleans"])) + +dc = DropColumns().setCols([]) + +dc.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = (Seq( + (0, 0.toDouble, "guitars", "drums", 1.toLong, true), + (1, 1.toDouble, "piano", "trumpet", 2.toLong, false), + (2, 2.toDouble, "bass", "cymbals", 3.toLong, true)) + .toDF("numbers", "doubles", "words", "more", "longs", "booleans")) + +val dc = new DropColumns().setCols(Array()) + +dc.transform(df).show() +``` + + + + + + + +### EnsembleByKey + + + + + + + + + +```python +from synapse.ml.stages import * +from pyspark.ml.feature import VectorAssembler + +scoreDF = (spark.createDataFrame([ + (0, "foo", 1.0, .1), + (1, "bar", 4.0, -2.0), + (1, "bar", 0.0, -3.0) + ], ["label1", "label2", "score1", "score2"])) + +va = VectorAssembler().setInputCols(["score1", "score2"]).setOutputCol("v1") +scoreDF2 = va.transform(scoreDF) + +ebk = EnsembleByKey().setKeys(["label1"]).setCols(["score1"]) + +ebk.transform(scoreDF2).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ +import org.apache.spark.ml.feature.VectorAssembler + +val scoreDF = (Seq( + (0, "foo", 1.0, .1), + (1, "bar", 4.0, -2.0), + (1, "bar", 0.0, -3.0)) + .toDF("label1", "label2", "score1", "score2")) + +val va = new VectorAssembler().setInputCols(Array("score1", "score2")).setOutputCol("v1") +val scoreDF2 = va.transform(scoreDF) + +val ebk = new EnsembleByKey().setKey("label1").setCol("score1") + +ebk.transform(scoreDF2).show() +``` + + + + + + + +### Explode + + + + + + + + + +```python +from synapse.ml.stages import * + +df = (spark.createDataFrame([ + (0, ["guitars", "drums"]), + (1, ["piano"]), + (2, []) + ], ["numbers", "words"])) + +explode = Explode().setInputCol("words").setOutputCol("exploded") + +explode.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = (Seq( + (0, Seq("guitars", "drums")), + (1, Seq("piano")), + (2, Seq())) + .toDF("numbers", "words")) + +val explode = new Explode().setInputCol("words").setOutputCol("exploded") + +explode.transform(df).show() +``` + + + + + + + +### Lambda + + + + + + + + + +```python +from synapse.ml.stages import * +from pyspark.sql.types import StringType, StructType + +df = (spark.createDataFrame([ + (0, 0.0, "guitars", "drums", 1, True), + (1, 1.0, "piano", "trumpet", 2, False), + (2, 2.0, "bass", "cymbals", 3, True) + ], ["numbers", "doubles", "words", "more", "longs", "booleans"])) + +def transformFunc(df): + return df.select("numbers") + +def transformSchemaFunc(schema): + return StructType([schema("numbers")]) + +l = (Lambda() + .setTransformFunc(transformFunc) + .setTransformSchemaFunc(transformSchemaFunc)) + +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ +import org.apache.spark.sql.types.{StringType, StructType} + +val df = (Seq( + (0, 0.toDouble, "guitars", "drums", 1.toLong, true), + (1, 1.toDouble, "piano", "trumpet", 2.toLong, false), + (2, 2.toDouble, "bass", "cymbals", 3.toLong, true)) + .toDF("numbers", "doubles", "words", "more", "longs", "booleans")) + +val lambda = (new Lambda() + .setTransform(df => df.select("numbers")) + .setTransformSchema(schema => new StructType(Array(schema("numbers"))))) + +lambda.transform(df).show() +``` + + + + + + + +### DynamicMiniBatchTransformer + + + + + + + + + +```python +from synapse.ml.stages import * +from pyspark.sql.types import StringType, StructType + +df = (spark.createDataFrame([(_, "foo") for _ in range(1, 11)], ["in1", "in2"])) + +dmbt = DynamicMiniBatchTransformer() + +dmbt.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = (1 until 11).map(x => (x, "foo")).toDF("in1", "in2") + +val dmbt = new DynamicMiniBatchTransformer() + +dmbt.transform(df).show() +``` + + + + + + + +### FixedMiniBatchTransformer + + + + + + + + + +```python +from synapse.ml.stages import * + +fmbt = (FixedMiniBatchTransformer() + .setBuffered(True) + .setBatchSize(3)) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val fmbt = (new FixedMiniBatchTransformer() + .setBuffered(true) + .setBatchSize(3)) +``` + + + + + + + +### TimeIntervalMiniBatchTransformer + + + + + + + + + +```python +from synapse.ml.stages import * + +df = (spark.createDataFrame([(_, "foo") for _ in range(1, 11)], ["in1", "in2"])) + +timbt = (TimeIntervalMiniBatchTransformer() + .setMillisToWait(1000) + .setMaxBatchSize(30)) + +timbt.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = (1 until 11).map(x => (x, "foo")).toDF("in1", "in2") + +val timbt = (new TimeIntervalMiniBatchTransformer() + .setMillisToWait(1000) + .setMaxBatchSize(30)) + +timbt.transform(df).show() +``` + + + + + + + +### FlattenBatch + + + + + + + + + +```python +from synapse.ml.stages import * + +df = (spark.createDataFrame([(_, "foo") for _ in range(1, 11)], ["in1", "in2"])) + +transDF = DynamicMiniBatchTransformer().transform(df) + +fb = FlattenBatch() + +fb.transform(transDF).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = (1 until 11).map(x => (x, "foo")).toDF("in1", "in2") + +val transDF = new DynamicMiniBatchTransformer().transform(df) + +val fb = new FlattenBatch() + +fb.transform(transDF).show() +``` + + + + + + + +### RenameColumn + + + + + + + + + +```python +from synapse.ml.stages import * + +df = (spark.createDataFrame([ + (0, 0, "guitars", "drums", 1, True), + (1, 1, "piano", "trumpet", 2, False), + (2, 2, "bass", "cymbals", 3, True) +], ["numbers", "doubles", "words", "more", "longs", "booleans"])) + +rc = RenameColumn().setInputCol("words").setOutputCol("numbers") + +rc.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = (Seq( + (0, 0.toDouble, "guitars", "drums", 1.toLong, true), + (1, 1.toDouble, "piano", "trumpet", 2.toLong, false), + (2, 2.toDouble, "bass", "cymbals", 3.toLong, true)) + .toDF("numbers", "doubles", "words", "more", "longs", "booleans")) + +val rc = new RenameColumn().setInputCol("words").setOutputCol("numbers") + +rc.transform(df).show() +``` + + + + + + + +### Repartition + + + + + + + + + +```python +from synapse.ml.stages import * + +df = (spark.createDataFrame([ + (0, "guitars", "drums"), + (1, "piano", "trumpet"), + (2, "bass", "cymbals"), + (3, "guitars", "drums"), + (4, "piano", "trumpet"), + (5, "bass", "cymbals"), + (6, "guitars", "drums"), + (7, "piano", "trumpet"), + (8, "bass", "cymbals"), + (9, "guitars", "drums"), + (10, "piano", "trumpet"), + (11, "bass", "cymbals") +], ["numbers", "words", "more"])) + +repartition = Repartition().setN(1) + +repartition.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = (Seq( + (0, "guitars", "drums"), + (1, "piano", "trumpet"), + (2, "bass", "cymbals"), + (3, "guitars", "drums"), + (4, "piano", "trumpet"), + (5, "bass", "cymbals"), + (6, "guitars", "drums"), + (7, "piano", "trumpet"), + (8, "bass", "cymbals"), + (9, "guitars", "drums"), + (10, "piano", "trumpet"), + (11, "bass", "cymbals") + ).toDF("numbers", "words", "more")) + +val repartition = new Repartition().setN(1) + +repartition.transform(df).show() +``` + + + + + + + +### SelectColumns + + + + + + + + + +```python +from synapse.ml.stages import * + +df = (spark.createDataFrame([ + (0, 0.0, "guitars", "drums", 1, True), + (1, 1.0, "piano", "trumpet", 2, False), + (2, 2.0, "bass", "cymbals", 3, True) +], ["numbers", "words", "more"])) + +sc = SelectColumns().setCols(["words", "more"]) + +sc.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = (Seq( + (0, 0.toDouble, "guitars", "drums", 1.toLong, true), + (1, 1.toDouble, "piano", "trumpet", 2.toLong, false), + (2, 2.toDouble, "bass", "cymbals", 3.toLong, true)) + .toDF("numbers", "doubles", "words", "more", "longs", "booleans")) + +val sc = new SelectColumns().setCols(Array("words", "more")) + +sc.transform(df).show() +``` + + + + + + + +### StratifiedRepartition + + + + + + + + + +```python +from synapse.ml.stages import * + +df = (spark.createDataFrame([ + (0, "Blue", 2), + (0, "Red", 2), + (0, "Green", 2), + (1, "Purple", 2), + (1, "Orange", 2), + (1, "Indigo", 2), + (2, "Violet", 2), + (2, "Black", 2), + (2, "White", 2), + (3, "Gray", 2), + (3, "Yellow", 2), + (3, "Cerulean", 2) +], ["values", "colors", "const"])) + +sr = StratifiedRepartition().setLabelCol("values").setMode("equal") +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = (Seq( + (0, "Blue", 2), + (0, "Red", 2), + (0, "Green", 2), + (1, "Purple", 2), + (1, "Orange", 2), + (1, "Indigo", 2), + (2, "Violet", 2), + (2, "Black", 2), + (2, "White", 2), + (3, "Gray", 2), + (3, "Yellow", 2), + (3, "Cerulean", 2) + ).toDF("values", "colors", "const")) + +val sr = new StratifiedRepartition().setLabelCol("values").setMode("equal") + +sr.transform(df).show() +``` + + + + + + + +### SummarizeData + + + + + + + + + +```python +from synapse.ml.stages import * + +df = (spark.createDataFrame([ + (0, 0.0, "guitars", "drums", 1, True), + (1, 1.0, "piano", "trumpet", 2, False), + (2, 2.0, "bass", "cymbals", 3, True) +], ["numbers", "doubles", "words", "more", "longs", "booleans"])) + +summary = SummarizeData() + +summary.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = (Seq( + (0, 0.toDouble, "guitars", "drums", 1.toLong, true), + (1, 1.toDouble, "piano", "trumpet", 2.toLong, false), + (2, 2.toDouble, "bass", "cymbals", 3.toLong, true)) + .toDF("numbers", "doubles", "words", "more", "longs", "booleans")) + +val summary = new SummarizeData() + +summary.transform(df).show() +``` + + + + + + + +### TextPreprocessor + + + + + + + + + +```python +from synapse.ml.stages import * + +df = (spark.createDataFrame([ + ("The happy sad boy drank sap", ), + ("The hater sad doy drank sap", ), + ("foo", ), + ("The hater sad doy aABc0123456789Zz_", ) +], ["words1"])) + +testMap = {"happy": "sad", "hater": "sap", + "sad": "sap", "sad doy": "sap"} + +textPreprocessor = (TextPreprocessor() + .setNormFunc("lowerCase") + .setMap(testMap) + .setInputCol("words1") + .setOutputCol("out")) + +textPreprocessor.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = (Seq( + ("The happy sad boy drank sap", ), + ("The hater sad doy drank sap", ), + ("foo", ), + ("The hater sad doy aABc0123456789Zz_", )) + .toDF("words1")) + +val testMap = Map[String, String] ( + "happy" -> "sad", + "hater" -> "sap", + "sad" -> "sap", + "sad doy" -> "sap" + ) + +val textPreprocessor = (new TextPreprocessor() + .setNormFunc("lowerCase") + .setMap(testMap) + .setInputCol("words1") + .setOutputCol("out")) + +textPreprocessor.transform(df).show() +``` + + + + + + + +### UDFTransformer + + + + + + + + + +```python +from synapse.ml.stages import * +from pyspark.sql.functions import udf + +df = (spark.createDataFrame([ + (0, 0.0, "guitars", "drums", 1, True), + (1, 1.0, "piano", "trumpet", 2, False), + (2, 2.0, "bass", "cymbals", 3, True) +], ["numbers", "doubles", "words", "more", "longs", "booleans"])) + +stringToIntegerUDF = udf(lambda x: 1) + +udfTransformer = (UDFTransformer() + .setUDF(stringToIntegerUDF) + .setInputCol("numbers") + .setOutputCol("out")) + +udfTransformer.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ +import org.apache.spark.sql.functions.udf + +val df = (Seq( + (0, 0.toDouble, "guitars", "drums", 1.toLong, true), + (1, 1.toDouble, "piano", "trumpet", 2.toLong, false), + (2, 2.toDouble, "bass", "cymbals", 3.toLong, true)) + .toDF("numbers", "doubles", "words", "more", "longs", "booleans")) + +val stringToIntegerUDF = udf((_: String) => 1) + +val udfTransformer = (new UDFTransformer() + .setUDF(stringToIntegerUDF) + .setInputCol("numbers") + .setOutputCol("out")) + +udfTransformer.transform(df).show() +``` + + + + + + + +### UnicodeNormalize + + + + + + + + + +```python +from synapse.ml.stages import * + +df = (spark.createDataFrame([ + ("Schön", 1), + ("Scho\u0308n", 1), + (None, 1) +], ["words1", "dummy"])) + +unicodeNormalize = (UnicodeNormalize() + .setForm("NFC") + .setInputCol("words1") + .setOutputCol("norm1")) + +unicodeNormalize.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.stages._ + +val df = (Seq( + ("Schön", 1), + ("Scho\u0308n", 1), + (null, 1)) + .toDF("words1", "dummy")) + +val unicodeNormalize = (new UnicodeNormalize() + .setForm("NFC") + .setInputCol("words1") + .setOutputCol("norm1")) + +unicodeNormalize.transform(df).show() +``` + + + + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/core/_SuperpixelTransformer.md b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_SuperpixelTransformer.md new file mode 100644 index 0000000000..1c7c06890d --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_SuperpixelTransformer.md @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## LIME + +### SuperpixelTransformer + + + + + + +```python +from synapse.ml.lime import * + +spt = (SuperpixelTransformer() + .setInputCol("images")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.lime._ + +val spt = (new SuperpixelTransformer() + .setInputCol("images")) +``` + + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Train.md b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Train.md new file mode 100644 index 0000000000..ba7a242c53 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/core/_Train.md @@ -0,0 +1,152 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + + + +## Train + +### ComputeModelStatistics + + + + + + +```python +from synapse.ml.train import * +from numpy import random + +df = spark.createDataFrame( + [(random.rand(), random.rand()) for _ in range(4096)], ["label", "prediction"] +) + +cms = (ComputeModelStatistics() + .setLabelCol("label") + .setScoredLabelsCol("prediction") + .setEvaluationMetric("classification")) + +cms.transform(df).show() +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.train._ +import scala.util.Random + +val rand = new Random(1337) +val df = (Seq.fill(4096)(rand.nextDouble()) + .zip(Seq.fill(4096)(rand.nextDouble())) + .toDF("label", "prediction")) + +val cms = (new ComputeModelStatistics() + .setLabelCol("label") + .setScoredLabelsCol("prediction") + .setEvaluationMetric("classification")) + +cms.transform(df).show() +``` + + + + + + + +### ComputePerInstanceStatistics + + + + + + + + + +```python +from synapse.ml.train import * + +cps = (ComputePerInstanceStatistics() + .setLabelCol("label") + .setScoredLabelsCol("LogRegScoredLabelsCol") + .setScoresCol("LogRegScoresCol") + .setScoredProbabilitiesCol("LogRegProbCol") + .setEvaluationMetric("classification")) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.train._ +import org.apache.spark.ml.classification.LogisticRegression +import org.apache.spark.ml.feature.FastVectorAssembler + +val logisticRegression = (new LogisticRegression() + .setRegParam(0.3) + .setElasticNetParam(0.8) + .setMaxIter(10) + .setLabelCol("label") + .setPredictionCol("LogRegScoredLabelsCol") + .setRawPredictionCol("LogRegScoresCol") + .setProbabilityCol("LogRegProbCol") + .setFeaturesCol("features")) + +val dataset = spark.createDataFrame(Seq( + (0.0, 2, 0.50, 0.60, 0.0), + (1.0, 3, 0.40, 0.50, 1.0), + (2.0, 4, 0.78, 0.99, 2.0), + (3.0, 5, 0.12, 0.34, 3.0), + (0.0, 1, 0.50, 0.60, 0.0), + (1.0, 3, 0.40, 0.50, 1.0), + (2.0, 3, 0.78, 0.99, 2.0), + (3.0, 4, 0.12, 0.34, 3.0), + (0.0, 0, 0.50, 0.60, 0.0), + (1.0, 2, 0.40, 0.50, 1.0), + (2.0, 3, 0.78, 0.99, 2.0), + (3.0, 4, 0.12, 0.34, 3.0))) + .toDF("label", "col1", "col2", "col3", "prediction") + +val assembler = (new FastVectorAssembler() + .setInputCols(Array("col1", "col2", "col3")) + .setOutputCol("features")) +val assembledDataset = assembler.transform(dataset) +val model = logisticRegression.fit(assembledDataset) +val scoredData = model.transform(assembledDataset) + +val cps = (new ComputePerInstanceStatistics() + .setLabelCol("label") + .setScoredLabelsCol("LogRegScoredLabelsCol") + .setScoresCol("LogRegScoresCol") + .setScoredProbabilitiesCol("LogRegProbCol") + .setEvaluationMetric("classification")) + +cps.transform(scoredData).show() +``` + + + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/deep_learning/_ONNXModel.md b/website/versioned_docs/version-0.9.5/documentation/transformers/deep_learning/_ONNXModel.md new file mode 100644 index 0000000000..84fd7f1df6 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/deep_learning/_ONNXModel.md @@ -0,0 +1,46 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import DocTable from "@theme/DocumentationTable"; + + +## ONNXModel + + + + +```py +from synapse.ml.onnx import ONNXModel + +model_path = "PUT_YOUR_MODEL_PATH" +onnx_ml = (ONNXModel() + .setModelLocation(model_path) + .setFeedDict({"float_input": "features"}) + .setFetchDict({"prediction": "output_label", "rawProbability": "output_probability"})) +``` + + + + +```scala +import com.microsoft.azure.synapse.ml.onnx._ + +val model_path = "PUT_YOUR_MODEL_PATH" +val onnx_ml = (new ONNXModel() + .setModelLocation(model_path) + .setFeedDict(Map("float_input" -> "features")) + .setFetchDict(Map("prediction" -> "output_label", "rawProbability" -> "output_probability"))) +``` + + + + + + diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_cognitive.md b/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_cognitive.md new file mode 100644 index 0000000000..0cd76ed4e9 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_cognitive.md @@ -0,0 +1,55 @@ +--- +title: Transformers - Cognitive +sidebar_label: Cognitive +hide_title: true +--- + + +import TextAnalytics, {toc as TextAnalyticsTOC} from './cognitive/_TextAnalytics.md'; + + + + +import Translator, {toc as TranslatorTOC} from './cognitive/_Translator.md'; + + + + +import ComputerVision, {toc as ComputerVisionTOC} from './cognitive/_ComputerVision.md'; + + + + +import FormRecognizer, {toc as FormRecognizerTOC} from './cognitive/_FormRecognizer.md'; + + + + +import AnomalyDetection, {toc as AnomalyDetectionTOC} from './cognitive/_AnomalyDetection.md'; + + + + +import Face, {toc as FaceTOC} from './cognitive/_Face.md'; + + + + +import SpeechToText, {toc as SpeechToTextTOC} from './cognitive/_SpeechToText.md'; + + + + +import AzureSearch, {toc as AzureSearchTOC} from './cognitive/_AzureSearch.md'; + + + + +import BingImageSearch, {toc as BingImageSearchTOC} from './cognitive/_BingImageSearch.md'; + + + + +export const toc = [...TextAnalyticsTOC, ...TranslatorTOC, ...ComputerVisionTOC, +...FormRecognizerTOC, ...AnomalyDetectionTOC, ...FaceTOC, ...SpeechToTextTOC, +...AzureSearchTOC, ...BingImageSearchTOC] diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_core.md b/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_core.md new file mode 100644 index 0000000000..dbd1d79b66 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_core.md @@ -0,0 +1,43 @@ +--- +title: Transformers - Core +sidebar_label: Core +hide_title: true +--- + + +import Explainers, {toc as ExplainersTOC} from './core/_Explainers.md'; + + + + +import Featurize, {toc as FeaturizeTOC} from './core/_Featurize.md'; + + + + +import Image, {toc as ImageTOC} from './core/_Image.md'; + + + + +import IO, {toc as IOTOC} from './core/_IO.md'; + + + + +import SuperpixelTransformer, {toc as LIMETOC} from './core/_SuperpixelTransformer.md'; + + + + +import Stages, {toc as StagesTOC} from './core/_Stages.md'; + + + + +import Train, {toc as TrainTOC} from './core/_Train.md'; + + + +export const toc = [...ExplainersTOC, ...FeaturizeTOC, ...ImageTOC, +...IOTOC, ...LIMETOC, ...StagesTOC, ...TrainTOC] \ No newline at end of file diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_deep_learning.md b/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_deep_learning.md new file mode 100644 index 0000000000..c02ff1e621 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_deep_learning.md @@ -0,0 +1,10 @@ +--- +title: Deep Learning +sidebar_label: Deep Learning +--- + +import ONNXModel, {toc as ONNXModelTOC} from './deep_learning/_ONNXModel.md'; + + + +export const toc = [...ONNXModelTOC] diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_opencv.md b/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_opencv.md new file mode 100644 index 0000000000..fb5ce7f173 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_opencv.md @@ -0,0 +1,13 @@ +--- +title: Transformers - OpenCV +sidebar_label: OpenCV +hide_title: true +--- + +# OpenCV + +import OpenCV, {toc as OpenCVTOC} from './_OpenCV.md'; + + + +export const toc = [...OpenCVTOC] diff --git a/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_vw.md b/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_vw.md new file mode 100644 index 0000000000..019e7d2f56 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/documentation/transformers/transformers_vw.md @@ -0,0 +1,13 @@ +--- +title: Transformers - Vowpal Wabbit +sidebar_label: Vowpal Wabbit +hide_title: true +--- + +# Vowpal Wabbit + +import VW, {toc as VWTOC} from './_VW.md'; + + + +export const toc = [...VWTOC] diff --git a/website/versioned_docs/version-0.9.5/features/classification/Classification - Adult Census with Vowpal Wabbit.md b/website/versioned_docs/version-0.9.5/features/classification/Classification - Adult Census with Vowpal Wabbit.md new file mode 100644 index 0000000000..911d614a0a --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/classification/Classification - Adult Census with Vowpal Wabbit.md @@ -0,0 +1,83 @@ +--- +title: Classification - Adult Census with Vowpal Wabbit +hide_title: true +status: stable +--- +# Classification - Adult Census using Vowpal Wabbit in SynapseML + +In this example, we predict incomes from the *Adult Census* dataset using Vowpal Wabbit (VW) classifier in SynapseML. +First, we read the data and split it into train and test sets as in this [example](https://github.com/Microsoft/SynapseML/blob/master/notebooks/Classification%20-%20Adult%20Census.ipynb +). + + +```python +import os +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() +``` + + +```python +data = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/AdultCensusIncome.parquet") +data = data.select(["education", "marital-status", "hours-per-week", "income"]) +train, test = data.randomSplit([0.75, 0.25], seed=123) +train.limit(10).toPandas() +``` + +Next, we define a pipeline that includes feature engineering and training of a VW classifier. We use a featurizer provided by VW that hashes the feature names. +Note that VW expects classification labels being -1 or 1. Thus, the income category is mapped to this space before feeding training data into the pipeline. + + +```python +from pyspark.sql.functions import when, col +from pyspark.ml import Pipeline +from synapse.ml.vw import VowpalWabbitFeaturizer, VowpalWabbitClassifier + +# Define classification label +train = train.withColumn("label", when(col("income").contains("<"), 0.0).otherwise(1.0)).repartition(1).cache() +print(train.count()) + +# Specify featurizer +vw_featurizer = VowpalWabbitFeaturizer(inputCols=["education", "marital-status", "hours-per-week"], + outputCol="features") + +# Define VW classification model +args = "--loss_function=logistic --quiet --holdout_off" +vw_model = VowpalWabbitClassifier(featuresCol="features", + labelCol="label", + args=args, + numPasses=10) + +# Create a pipeline +vw_pipeline = Pipeline(stages=[vw_featurizer, vw_model]) +``` + +Then, we are ready to train the model by fitting the pipeline with the training data. + + +```python +# Train the model +vw_trained = vw_pipeline.fit(train) +``` + +After the model is trained, we apply it to predict the income of each sample in the test set. + + +```python +# Making predictions +test = test.withColumn("label", when(col("income").contains("<"), 0.0).otherwise(1.0)) +prediction = vw_trained.transform(test) +prediction.limit(10).toPandas() +``` + +Finally, we evaluate the model performance using `ComputeModelStatistics` function which will compute confusion matrix, accuracy, precision, recall, and AUC by default for classificaiton models. + + +```python +from synapse.ml.train import ComputeModelStatistics +metrics = ComputeModelStatistics(evaluationMetric="classification", + labelCol="label", + scoredLabelsCol="prediction").transform(prediction) +metrics.toPandas() +``` diff --git a/website/versioned_docs/version-0.9.5/features/classification/Classification - Adult Census.md b/website/versioned_docs/version-0.9.5/features/classification/Classification - Adult Census.md new file mode 100644 index 0000000000..1541bd7c4f --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/classification/Classification - Adult Census.md @@ -0,0 +1,58 @@ +--- +title: Classification - Adult Census +hide_title: true +status: stable +--- +## Classification - Adult Census + +In this example, we try to predict incomes from the *Adult Census* dataset. + +First, we import the packages (use `help(synapse)` to view contents), + + +```python +import os +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() +``` + + +```python +import numpy as np +import pandas as pd +``` + +Now let's read the data and split it to train and test sets: + + +```python +data = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/AdultCensusIncome.parquet") +data = data.select(["education", "marital-status", "hours-per-week", "income"]) +train, test = data.randomSplit([0.75, 0.25], seed=123) +train.limit(10).toPandas() +``` + +`TrainClassifier` can be used to initialize and fit a model, it wraps SparkML classifiers. +You can use `help(synapse.ml.train.TrainClassifier)` to view the different parameters. + +Note that it implicitly converts the data into the format expected by the algorithm: tokenize +and hash strings, one-hot encodes categorical variables, assembles the features into a vector +and so on. The parameter `numFeatures` controls the number of hashed features. + + +```python +from synapse.ml.train import TrainClassifier +from pyspark.ml.classification import LogisticRegression +model = TrainClassifier(model=LogisticRegression(), labelCol="income", numFeatures=256).fit(train) +``` + +Finally, we save the model so it can be used in a scoring program. + + +```python +if os.environ.get("AZURE_SERVICE", None) != "Microsoft.ProjectArcadia": + model.write().overwrite().save("dbfs:/AdultCensus.mml") +else: + model.write().overwrite().save("abfss://synapse@mmlsparkeuap.dfs.core.windows.net/models/AdultCensus.mml") +``` diff --git a/website/versioned_docs/version-0.9.5/features/classification/Classification - Before and After SynapseML.md b/website/versioned_docs/version-0.9.5/features/classification/Classification - Before and After SynapseML.md new file mode 100644 index 0000000000..db9ba23bb2 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/classification/Classification - Before and After SynapseML.md @@ -0,0 +1,205 @@ +--- +title: Classification - Before and After SynapseML +hide_title: true +status: stable +--- +## Classification - Before and After SynapseML + +### 1. Introduction + +


+ +In this tutorial, we perform the same classification task in two +different ways: once using plain **`pyspark`** and once using the +**`synapseml`** library. The two methods yield the same performance, +but one of the two libraries is drastically simpler to use and iterate +on (can you guess which one?). + +The task is simple: Predict whether a user's review of a book sold on +Amazon is good (rating > 3) or bad based on the text of the review. We +accomplish this by training LogisticRegression learners with different +hyperparameters and choosing the best model. + + +```python +import os +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() +``` + +### 2. Read the data + +We download and read in the data. We show a sample below: + + +```python +rawData = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/BookReviewsFromAmazon10K.parquet") +rawData.show(5) +``` + +### 3. Extract more features and process data + +Real data however is more complex than the above dataset. It is common +for a dataset to have features of multiple types: text, numeric, +categorical. To illustrate how difficult it is to work with these +datasets, we add two numerical features to the dataset: the **word +count** of the review and the **mean word length**. + + +```python +from pyspark.sql.functions import udf +from pyspark.sql.types import * +def wordCount(s): + return len(s.split()) +def wordLength(s): + import numpy as np + ss = [len(w) for w in s.split()] + return round(float(np.mean(ss)), 2) +wordLengthUDF = udf(wordLength, DoubleType()) +wordCountUDF = udf(wordCount, IntegerType()) +``` + + +```python +from synapse.ml.stages import UDFTransformer +wordLength = "wordLength" +wordCount = "wordCount" +wordLengthTransformer = UDFTransformer(inputCol="text", outputCol=wordLength, udf=wordLengthUDF) +wordCountTransformer = UDFTransformer(inputCol="text", outputCol=wordCount, udf=wordCountUDF) + +``` + + +```python +from pyspark.ml import Pipeline +data = Pipeline(stages=[wordLengthTransformer, wordCountTransformer]) \ + .fit(rawData).transform(rawData) \ + .withColumn("label", rawData["rating"] > 3).drop("rating") +``` + + +```python +data.show(5) +``` + +### 4a. Classify using pyspark + +To choose the best LogisticRegression classifier using the `pyspark` +library, need to *explictly* perform the following steps: + +1. Process the features: + * Tokenize the text column + * Hash the tokenized column into a vector using hashing + * Merge the numeric features with the vector in the step above +2. Process the label column: cast it into the proper type. +3. Train multiple LogisticRegression algorithms on the `train` dataset + with different hyperparameters +4. Compute the area under the ROC curve for each of the trained models + and select the model with the highest metric as computed on the + `test` dataset +5. Evaluate the best model on the `validation` set + +As you can see below, there is a lot of work involved and a lot of +steps where something can go wrong! + + +```python +from pyspark.ml.feature import Tokenizer, HashingTF +from pyspark.ml.feature import VectorAssembler + +# Featurize text column +tokenizer = Tokenizer(inputCol="text", outputCol="tokenizedText") +numFeatures = 10000 +hashingScheme = HashingTF(inputCol="tokenizedText", + outputCol="TextFeatures", + numFeatures=numFeatures) +tokenizedData = tokenizer.transform(data) +featurizedData = hashingScheme.transform(tokenizedData) + +# Merge text and numeric features in one feature column +featureColumnsArray = ["TextFeatures", "wordCount", "wordLength"] +assembler = VectorAssembler( + inputCols = featureColumnsArray, + outputCol="features") +assembledData = assembler.transform(featurizedData) + +# Select only columns of interest +# Convert rating column from boolean to int +processedData = assembledData \ + .select("label", "features") \ + .withColumn("label", assembledData.label.cast(IntegerType())) +``` + + +```python +from pyspark.ml.evaluation import BinaryClassificationEvaluator +from pyspark.ml.classification import LogisticRegression + +# Prepare data for learning +train, test, validation = processedData.randomSplit([0.60, 0.20, 0.20], seed=123) + +# Train the models on the 'train' data +lrHyperParams = [0.05, 0.1, 0.2, 0.4] +logisticRegressions = [LogisticRegression(regParam = hyperParam) + for hyperParam in lrHyperParams] +evaluator = BinaryClassificationEvaluator(rawPredictionCol="rawPrediction", + metricName="areaUnderROC") +metrics = [] +models = [] + +# Select the best model +for learner in logisticRegressions: + model = learner.fit(train) + models.append(model) + scoredData = model.transform(test) + metrics.append(evaluator.evaluate(scoredData)) +bestMetric = max(metrics) +bestModel = models[metrics.index(bestMetric)] + +# Get AUC on the validation dataset +scoredVal = bestModel.transform(validation) +print(evaluator.evaluate(scoredVal)) +``` + +### 4b. Classify using synapseml + +Life is a lot simpler when using `synapseml`! + +1. The **`TrainClassifier`** Estimator featurizes the data internally, + as long as the columns selected in the `train`, `test`, `validation` + dataset represent the features + +2. The **`FindBestModel`** Estimator find the best model from a pool of + trained models by find the model which performs best on the `test` + dataset given the specified metric + +3. The **`CompueModelStatistics`** Transformer computes the different + metrics on a scored dataset (in our case, the `validation` dataset) + at the same time + + +```python +from synapse.ml.train import TrainClassifier, ComputeModelStatistics +from synapse.ml.automl import FindBestModel + +# Prepare data for learning +train, test, validation = data.randomSplit([0.60, 0.20, 0.20], seed=123) + +# Train the models on the 'train' data +lrHyperParams = [0.05, 0.1, 0.2, 0.4] +logisticRegressions = [LogisticRegression(regParam = hyperParam) + for hyperParam in lrHyperParams] +lrmodels = [TrainClassifier(model=lrm, labelCol="label", numFeatures=10000).fit(train) + for lrm in logisticRegressions] + +# Select the best model +bestModel = FindBestModel(evaluationMetric="AUC", models=lrmodels).fit(test) + + +# Get AUC on the validation dataset +predictions = bestModel.transform(validation) +metrics = ComputeModelStatistics().transform(predictions) +print("Best model's AUC on validation set = " + + "{0:.2f}%".format(metrics.first()["AUC"] * 100)) +``` diff --git a/website/versioned_docs/version-0.9.5/features/classification/Classification - Twitter Sentiment with Vowpal Wabbit.md b/website/versioned_docs/version-0.9.5/features/classification/Classification - Twitter Sentiment with Vowpal Wabbit.md new file mode 100644 index 0000000000..109730a59c --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/classification/Classification - Twitter Sentiment with Vowpal Wabbit.md @@ -0,0 +1,211 @@ +--- +title: Classification - Twitter Sentiment with Vowpal Wabbit +hide_title: true +status: stable +--- +# Twitter Sentiment Classification using Vowpal Wabbit in SynapseML + +In this example, we show how to build a sentiment classification model using Vowpal Wabbit (VW) in SynapseML. The data set we use to train and evaluate the model is [Sentiment140](http://help.sentiment140.com/for-students/?source=post_page---------------------------) twitter data. First, we import a few packages that we need. + + +```python +import os +import re +import urllib.request +import numpy as np +import pandas as pd +from zipfile import ZipFile +from bs4 import BeautifulSoup +from pyspark.sql.functions import udf, rand, when, col +from pyspark.sql.types import StructType, StructField, DoubleType, StringType +from pyspark.ml import Pipeline +from pyspark.ml.feature import CountVectorizer, RegexTokenizer +from synapse.ml.vw import VowpalWabbitClassifier +from synapse.ml.train import ComputeModelStatistics +from pyspark.mllib.evaluation import BinaryClassificationMetrics +import matplotlib.pyplot as plt +``` + + +```python +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() +``` + + +```python +# URL to download the sentiment140 dataset and data file names +DATA_URL = "http://cs.stanford.edu/people/alecmgo/trainingandtestdata.zip" +TRAIN_FILENAME = "training.1600000.processed.noemoticon.csv" +TEST_FILENAME = "testdata.manual.2009.06.14.csv" +# Folder for storing the downloaded data +DATA_FOLDER = "data" +# Data column names +COL_NAMES = ["label", "id", "date", "query_string", "user", "text"] +# Text encoding type of the data +ENCODING = "iso-8859-1" +``` + +## Data Preparation + +We use [Sentiment140](http://help.sentiment140.com/for-students/?source=post_page---------------------------) twitter data which originated from a Standford research project to train and evaluate VW classification model on Spark. The same dataset has been used in a previous [Azure Machine Learning sample](https://github.com/Azure-Samples/MachineLearningSamples-TwitterSentimentPrediction) on twitter sentiment prediction. Before using the data to build the classification model, we first download and clean up the data. + + +```python +def download_data(url, data_folder=DATA_FOLDER, filename="downloaded_data.zip"): + """Download and extract data from url""" + + data_dir = "./" + DATA_FOLDER + if not os.path.exists(data_dir): os.makedirs(data_dir) + downloaded_filepath = os.path.join(data_dir, filename) + print("Downloading data...") + urllib.request.urlretrieve(url, downloaded_filepath) + print("Extracting data...") + zipfile = ZipFile(downloaded_filepath) + zipfile.extractall(data_dir) + zipfile.close() + print("Finished data downloading and extraction.") + +download_data(DATA_URL) +``` + +Let's read the training data into a Spark DataFrame. + + +```python +df_train = pd.read_csv(os.path.join(".", DATA_FOLDER, TRAIN_FILENAME), + header=None, names=COL_NAMES, encoding=ENCODING) +df_train = spark.createDataFrame(df_train, verifySchema=False) +``` + +We can take a look at the training data and check how many samples it has. We should see that there are 1.6 million samples in the training data. There are 6 fields in the training data: +* label: the sentiment of the tweet (0.0 = negative, 2.0 = neutral, 4.0 = positive) +* id: the id of the tweet +* date: the date of the tweet +* query_string: The query used to extract the data. If there is no query, then this value is NO_QUERY. +* user: the user that tweeted +* text: the text of the tweet + + +```python +df_train.limit(10).toPandas() +``` + + +```python +print("Number of training samples: ", df_train.count()) +``` + +Before training the model, we randomly permute the data to mix negative and positive samples. This is helpful for properly training online learning algorithms like VW. To speed up model training, we use a subset of the data to train the model. If training with the full training set, typically you will see better performance of the model on the test set. + + +```python +df_train = df_train.orderBy(rand()) \ + .limit(100000) \ + .withColumn("label", when(col("label") > 0, 1.0).otherwise(0.0)) \ + .select(["label", "text"]) +``` + +## VW SynapseML Training + +Now we are ready to define a pipeline which consists of feture engineering steps and the VW model. + + +```python +# Specify featurizers +tokenizer = RegexTokenizer(inputCol="text", + outputCol="words") + +count_vectorizer = CountVectorizer(inputCol="words", + outputCol="features") + +# Define VW classification model +args = "--loss_function=logistic --quiet --holdout_off" +vw_model = VowpalWabbitClassifier(featuresCol="features", + labelCol="label", + args=args, + numPasses=10) + +# Create a pipeline +vw_pipeline = Pipeline(stages=[tokenizer, count_vectorizer, vw_model]) +``` + +With the prepared training data, we can fit the model pipeline as follows. + + +```python +vw_trained = vw_pipeline.fit(df_train) +``` + +## Model Performance Evaluation + +After training the model, we evaluate the performance of the model using the test set which is manually labeled. + + +```python +df_test = pd.read_csv(os.path.join(".", DATA_FOLDER, TEST_FILENAME), + header=None, names=COL_NAMES, encoding=ENCODING) +df_test = spark.createDataFrame(df_test, verifySchema=False) +``` + +We only use positive and negative tweets in the test set to evaluate the model, since our model is a binary classification model trained with only positive and negative tweets. + + +```python +print("Number of test samples before filtering: ", df_test.count()) +df_test = df_test.filter(col("label") != 2.0) \ + .withColumn("label", when(col("label") > 0, 1.0).otherwise(0.0)) \ + .select(["label", "text"]) +print("Number of test samples after filtering: ", df_test.count()) +``` + + +```python +# Make predictions +predictions = vw_trained.transform(df_test) +predictions.limit(10).toPandas() +``` + + +```python +# Compute model performance metrics +metrics = ComputeModelStatistics(evaluationMetric="classification", + labelCol="label", + scoredLabelsCol="prediction").transform(predictions) +metrics.toPandas() +``` + + +```python +# Utility class for plotting ROC curve (https://stackoverflow.com/questions/52847408/pyspark-extract-roc-curve) +class CurveMetrics(BinaryClassificationMetrics): + def __init__(self, *args): + super(CurveMetrics, self).__init__(*args) + + def get_curve(self, method): + rdd = getattr(self._java_model, method)().toJavaRDD() + points = [] + for row in rdd.collect(): + points += [(float(row._1()), float(row._2()))] + return points + +preds = predictions.select("label", "probability") \ + .rdd.map(lambda row: (float(row["probability"][1]), float(row["label"]))) +roc_points = CurveMetrics(preds).get_curve("roc") + +# Plot ROC curve +fig = plt.figure() +x_val = [x[0] for x in roc_points] +y_val = [x[1] for x in roc_points] +plt.title("ROC curve on test set") +plt.xlabel("False positive rate") +plt.ylabel("True positive rate") +plt.plot(x_val, y_val) +# Use display() if you're on Azure Databricks or you can do plt.show() +plt.show() +``` + +You should see an ROC curve like the following after the above cell is executed. + + diff --git a/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Analyze Text.md b/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Analyze Text.md new file mode 100644 index 0000000000..a837c8b246 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Analyze Text.md @@ -0,0 +1,78 @@ +--- +title: CognitiveServices - Analyze Text +hide_title: true +status: stable +--- +# Cognitive Services - Analyze Text + + + + +```python +import os + +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() + from notebookutils.mssparkutils.credentials import getSecret + os.environ['TEXT_API_KEY'] = getSecret("mmlspark-keys", "mmlspark-cs-key") + +#put your service keys here +key = os.environ['TEXT_API_KEY'] +location = 'eastus' +``` + + +```python + +df = spark.createDataFrame(data=[ + ["en", "Hello Seattle"], + ["en", "There once was a dog who lived in London and thought she was a human"] + ], + schema=["language","text"]) +``` + + +```python +display(df) +``` + + +```python +from synapse.ml.cognitive import * + +text_analyze = (TextAnalyze() + .setLocation(location) + .setSubscriptionKey(key) + .setTextCol("text") + .setOutputCol("textAnalysis") + .setErrorCol("error") + .setLanguageCol("language") + # set the tasks to perform + .setEntityRecognitionTasks([{"parameters": { "model-version": "latest"}}]) + .setKeyPhraseExtractionTasks([{"parameters": { "model-version": "latest"}}]) + # Uncomment these lines to add more tasks + # .setEntityRecognitionPiiTasks([{"parameters": { "model-version": "latest"}}]) + # .setEntityLinkingTasks([{"parameters": { "model-version": "latest"}}]) + # .setSentimentAnalysisTasks([{"parameters": { "model-version": "latest"}}]) + ) + +df_results = text_analyze.transform(df) + +``` + + +```python +display(df_results) +``` + + +```python +from pyspark.sql.functions import col + +# reformat and display for easier viewing +display( + df_results.select("language", "text", "error", col("textAnalysis").getItem(0)) # we are not batching so only have a single result + .select("language", "text", "error", "textAnalysis[0].*") # explode the Text Analytics tasks into columns +) +``` diff --git a/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Celebrity Quote Analysis.md b/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Celebrity Quote Analysis.md new file mode 100644 index 0000000000..89536f87d8 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Celebrity Quote Analysis.md @@ -0,0 +1,131 @@ +--- +title: CognitiveServices - Celebrity Quote Analysis +hide_title: true +status: stable +--- +# Celebrity Quote Analysis with The Cognitive Services on Spark + + + + +```python +from synapse.ml.cognitive import * +from pyspark.ml import PipelineModel +from pyspark.sql.functions import col, udf +from pyspark.ml.feature import SQLTransformer +import os + +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() + from notebookutils.mssparkutils.credentials import getSecret + os.environ['VISION_API_KEY'] = getSecret("mmlspark-keys", "mmlspark-cs-key") + os.environ['TEXT_API_KEY'] = getSecret("mmlspark-keys", "mmlspark-cs-key") + os.environ['BING_IMAGE_SEARCH_KEY'] = getSecret("mmlspark-keys", "mmlspark-bing-search-key") + +#put your service keys here +TEXT_API_KEY = os.environ["TEXT_API_KEY"] +VISION_API_KEY = os.environ["VISION_API_KEY"] +BING_IMAGE_SEARCH_KEY = os.environ["BING_IMAGE_SEARCH_KEY"] +``` + +### Extracting celebrity quote images using Bing Image Search on Spark + +Here we define two Transformers to extract celebrity quote images. + + + + +```python +imgsPerBatch = 10 #the number of images Bing will return for each query +offsets = [(i*imgsPerBatch,) for i in range(100)] # A list of offsets, used to page into the search results +bingParameters = spark.createDataFrame(offsets, ["offset"]) + +bingSearch = BingImageSearch()\ + .setSubscriptionKey(BING_IMAGE_SEARCH_KEY)\ + .setOffsetCol("offset")\ + .setQuery("celebrity quotes")\ + .setCount(imgsPerBatch)\ + .setOutputCol("images") + +#Transformer to that extracts and flattens the richly structured output of Bing Image Search into a simple URL column +getUrls = BingImageSearch.getUrlTransformer("images", "url") +``` + +### Recognizing Images of Celebrities +This block identifies the name of the celebrities for each of the images returned by the Bing Image Search. + + + + +```python +celebs = RecognizeDomainSpecificContent()\ + .setSubscriptionKey(VISION_API_KEY)\ + .setModel("celebrities")\ + .setUrl("https://eastus.api.cognitive.microsoft.com/vision/v2.0/")\ + .setImageUrlCol("url")\ + .setOutputCol("celebs") + +#Extract the first celebrity we see from the structured response +firstCeleb = SQLTransformer(statement="SELECT *, celebs.result.celebrities[0].name as firstCeleb FROM __THIS__") +``` + +### Reading the quote from the image. +This stage performs OCR on the images to recognize the quotes. + + + + +```python +from synapse.ml.stages import UDFTransformer + +recognizeText = RecognizeText()\ + .setSubscriptionKey(VISION_API_KEY)\ + .setUrl("https://eastus.api.cognitive.microsoft.com/vision/v2.0/recognizeText")\ + .setImageUrlCol("url")\ + .setMode("Printed")\ + .setOutputCol("ocr")\ + .setConcurrency(5) + +def getTextFunction(ocrRow): + if ocrRow is None: return None + return "\n".join([line.text for line in ocrRow.recognitionResult.lines]) + +# this transformer wil extract a simpler string from the structured output of recognize text +getText = UDFTransformer().setUDF(udf(getTextFunction)).setInputCol("ocr").setOutputCol("text") + +``` + +### Understanding the Sentiment of the Quote + + + + +```python +sentimentTransformer = TextSentiment()\ + .setTextCol("text")\ + .setUrl("https://eastus.api.cognitive.microsoft.com/text/analytics/v3.0/sentiment")\ + .setSubscriptionKey(TEXT_API_KEY)\ + .setOutputCol("sentiment") + +#Extract the sentiment score from the API response body +getSentiment = SQLTransformer(statement="SELECT *, sentiment[0].sentiment as sentimentLabel FROM __THIS__") +``` + +### Tying it all together + +Now that we have built the stages of our pipeline its time to chain them together into a single model that can be used to process batches of incoming data + + + + +```python +from synapse.ml.stages import SelectColumns +# Select the final coulmns +cleanupColumns = SelectColumns().setCols(["url", "firstCeleb", "text", "sentimentLabel"]) + +celebrityQuoteAnalysis = PipelineModel(stages=[ + bingSearch, getUrls, celebs, firstCeleb, recognizeText, getText, sentimentTransformer, getSentiment, cleanupColumns]) + +celebrityQuoteAnalysis.transform(bingParameters).show(5) +``` diff --git a/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Create a Multilingual Search Engine from Forms.md b/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Create a Multilingual Search Engine from Forms.md new file mode 100644 index 0000000000..f8c47e8e84 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Create a Multilingual Search Engine from Forms.md @@ -0,0 +1,164 @@ +--- +title: CognitiveServices - Create a Multilingual Search Engine from Forms +hide_title: true +status: stable +--- +```python +import os +key = os.environ['VISION_API_KEY'] +search_key = os.environ['AZURE_SEARCH_KEY'] +translator_key = os.environ['TRANSLATOR_KEY'] + +search_service = "mmlspark-azure-search" +search_index = "form-demo-index" +``` + + +```python +from pyspark.sql.functions import udf +from pyspark.sql.types import StringType + +def blob_to_url(blob): + [prefix, postfix] = blob.split("@") + container = prefix.split("/")[-1] + split_postfix = postfix.split("/") + account = split_postfix[0] + filepath = "/".join(split_postfix[1:]) + return "https://{}/{}/{}".format(account, container, filepath) + + +df2 = (spark.read.format("binaryFile") + .load("wasbs://ignite2021@mmlsparkdemo.blob.core.windows.net/form_subset/*") + .select("path") + .limit(10) + .select(udf(blob_to_url, StringType())("path").alias("url")) + .cache() + ) + +``` + + +```python +display(df2) +``` + + +```python +displayHTML(""" + +""") +``` + + +```python +from synapse.ml.cognitive import AnalyzeInvoices + +analyzed_df = (AnalyzeInvoices() + .setSubscriptionKey(key) + .setLocation("eastus") + .setImageUrlCol("url") + .setOutputCol("invoices") + .setErrorCol("errors") + .setConcurrency(5) + .transform(df2) + .cache()) + +``` + + +```python +display(analyzed_df) +``` + + +```python +from synapse.ml.cognitive import FormOntologyLearner + +organized_df = (FormOntologyLearner() + .setInputCol("invoices") + .setOutputCol("extracted") + .fit(analyzed_df) + .transform(analyzed_df) + .select("url", "extracted.*") + .cache()) +``` + + +```python +display(organized_df) +``` + + +```python +from pyspark.sql.functions import explode, col +itemized_df = (organized_df + .select("*", explode(col("Items")).alias("Item")) + .drop("Items") + .select("Item.*", "*") + .drop("Item")) + +``` + + +```python +display(itemized_df) +``` + + +```python +display(itemized_df.where(col("ProductCode") == 48)) +``` + + +```python +from synapse.ml.cognitive import Translate + +translated_df = (Translate() + .setSubscriptionKey(translator_key) + .setLocation("eastus") + .setTextCol("Description") + .setErrorCol("TranslationError") + .setOutputCol("output") + .setToLanguage(["zh-Hans", "fr", "ru", "cy"]) + .setConcurrency(5) + .transform(itemized_df) + .withColumn("Translations", col("output.translations")[0]) + .drop("output", "TranslationError") + .cache()) + +``` + + +```python +display(translated_df) +``` + + +```python +from synapse.ml.cognitive import * +from pyspark.sql.functions import monotonically_increasing_id, lit + +(translated_df + .withColumn("DocID", monotonically_increasing_id().cast("string")) + .withColumn("SearchAction", lit("upload")) + .writeToAzureSearch( + subscriptionKey=search_key, + actionCol="SearchAction", + serviceName=search_service, + indexName=search_index, + keyCol="DocID") +) + +``` + + +```python +import requests +url = 'https://{}.search.windows.net/indexes/{}/docs/search?api-version=2019-05-06'.format(search_service, search_index) +requests.post(url, json={"search": "door"}, headers = {"api-key": search_key}).json() +``` + + +```python + +``` diff --git a/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Overview.md b/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Overview.md new file mode 100644 index 0000000000..cc242d4c44 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Overview.md @@ -0,0 +1,426 @@ +--- +title: CognitiveServices - Overview +hide_title: true +status: stable +--- + + +# Cognitive Services + +[Azure Cognitive Services](https://azure.microsoft.com/en-us/services/cognitive-services/) are a suite of APIs, SDKs, and services available to help developers build intelligent applications without having direct AI or data science skills or knowledge by enabling developers to easily add cognitive features into their applications. The goal of Azure Cognitive Services is to help developers create applications that can see, hear, speak, understand, and even begin to reason. The catalog of services within Azure Cognitive Services can be categorized into five main pillars - Vision, Speech, Language, Web Search, and Decision. + +## Usage + +### Vision +[**Computer Vision**](https://azure.microsoft.com/en-us/services/cognitive-services/computer-vision/) +- Describe: provides description of an image in human readable language ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DescribeImage.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DescribeImage)) +- Analyze (color, image type, face, adult/racy content): analyzes visual features of an image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeImage.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeImage)) +- OCR: reads text from an image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/OCR.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.OCR)) +- Recognize Text: reads text from an image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/RecognizeText.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.RecognizeText)) +- Thumbnail: generates a thumbnail of user-specified size from the image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/GenerateThumbnails.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.GenerateThumbnails)) +- Recognize domain-specific content: recognizes domain-specific content (celebrity, landmark) ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/RecognizeDomainSpecificContent.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.RecognizeDomainSpecificContent)) +- Tag: identifies list of words that are relevant to the in0put image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/TagImage.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.TagImage)) + +[**Face**](https://azure.microsoft.com/en-us/services/cognitive-services/face/) +- Detect: detects human faces in an image ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DetectFace.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DetectFace)) +- Verify: verifies whether two faces belong to a same person, or a face belongs to a person ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/VerifyFaces.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.VerifyFaces)) +- Identify: finds the closest matches of the specific query person face from a person group ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/IdentifyFaces.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.IdentifyFaces)) +- Find similar: finds similar faces to the query face in a face list ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/FindSimilarFace.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.FindSimilarFace)) +- Group: divides a group of faces into disjoint groups based on similarity ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/GroupFaces.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.GroupFaces)) + +### Speech +[**Speech Services**](https://azure.microsoft.com/en-us/services/cognitive-services/speech-services/) +- Speech-to-text: transcribes audio streams ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/SpeechToText.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.SpeechToText)) +- Conversation Transcription: transcribes audio streams into live transcripts with identified speakers. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/ConversationTranscription.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.ConversationTranscription)) +- Text to Speech: Converts text to realistic audio ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/TextToSpeech.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.TextToSpeech)) + + +### Language +[**Text Analytics**](https://azure.microsoft.com/en-us/services/cognitive-services/text-analytics/) +- Language detection: detects language of the input text ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/LanguageDetector.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.LanguageDetector)) +- Key phrase extraction: identifies the key talking points in the input text ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/KeyPhraseExtractor.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.KeyPhraseExtractor)) +- Named entity recognition: identifies known entities and general named entities in the input text ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/NER.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.NER)) +- Sentiment analysis: returns a score betwee 0 and 1 indicating the sentiment in the input text ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/TextSentiment.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.TextSentiment)) +- Healthcare Entity Extraction: Extracts medical entities and relationships from text. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/HealthcareSDK.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.HealthcareSDK)) + + +### Translation +[**Translator**](https://azure.microsoft.com/en-us/services/cognitive-services/translator/) +- Translate: Translates text. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/Translate.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.Translate)) +- Transliterate: Converts text in one language from one script to another script. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/Transliterate.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.Transliterate)) +- Detect: Identifies the language of a piece of text. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/Detect.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.Detect)) +- BreakSentence: Identifies the positioning of sentence boundaries in a piece of text. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/BreakSentence.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.BreakSentence)) +- Dictionary Lookup: Provides alternative translations for a word and a small number of idiomatic phrases. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DictionaryLookup.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DictionaryLookup)) +- Dictionary Examples: Provides examples that show how terms in the dictionary are used in context. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DictionaryExamples.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DictionaryExamples)) +- Document Translation: Translates documents across all supported languages and dialects while preserving document structure and data format. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DocumentTranslator.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DocumentTranslator)) + +### Form Recognizer +[**Form Recognizer**](https://azure.microsoft.com/en-us/services/form-recognizer/) +- Analyze Layout: Extract text and layout information from a given document. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeLayout.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeLayout)) +- Analyze Receipts: Detects and extracts data from receipts using optical character recognition (OCR) and our receipt model, enabling you to easily extract structured data from receipts such as merchant name, merchant phone number, transaction date, transaction total, and more. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeReceipts.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeReceipts)) +- Analyze Business Cards: Detects and extracts data from business cards using optical character recognition (OCR) and our business card model, enabling you to easily extract structured data from business cards such as contact names, company names, phone numbers, emails, and more. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeBusinessCards.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeBusinessCards)) +- Analyze Invoices: Detects and extracts data from invoices using optical character recognition (OCR) and our invoice understanding deep learning models, enabling you to easily extract structured data from invoices such as customer, vendor, invoice ID, invoice due date, total, invoice amount due, tax amount, ship to, bill to, line items and more. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeInvoices.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeInvoices)) +- Analyze ID Documents: Detects and extracts data from identification documents using optical character recognition (OCR) and our ID document model, enabling you to easily extract structured data from ID documents such as first name, last name, date of birth, document number, and more. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeIDDocuments.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeIDDocuments)) +- Analyze Custom Form: Extracts information from forms (PDFs and images) into structured data based on a model created from a set of representative training forms. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/AnalyzeCustomModel.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AnalyzeCustomModel)) +- Get Custom Model: Get detailed information about a custom model. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/GetCustomModel.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/ListCustomModels.html)) +- List Custom Models: Get information about all custom models. ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/ListCustomModels.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.ListCustomModels)) + +### Decision +[**Anomaly Detector**](https://azure.microsoft.com/en-us/services/cognitive-services/anomaly-detector/) +- Anomaly status of latest point: generates a model using preceding points and determines whether the latest point is anomalous ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DetectLastAnomaly.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DetectLastAnomaly)) +- Find anomalies: generates a model using an entire series and finds anomalies in the series ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/DetectAnomalies.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.DetectAnomalies)) + +### Search +- [Bing Image search](https://azure.microsoft.com/en-us/services/cognitive-services/bing-image-search-api/) ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/com/microsoft/azure/synapse/ml/cognitive/BingImageSearch.html), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.BingImageSearch)) +- [Azure Cognitive search](https://docs.microsoft.com/en-us/azure/search/search-what-is-azure-search) ([Scala](https://mmlspark.blob.core.windows.net/docs/0.9.5/scala/index.html#com.microsoft.azure.synapse.ml.cognitive.AzureSearchWriter$), [Python](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.cognitive.html#module-synapse.ml.cognitive.AzureSearchWriter)) + + +## Prerequisites + +1. Follow the steps in [Getting started](https://docs.microsoft.com/en-us/azure/cognitive-services/big-data/getting-started) to set up your Azure Databricks and Cognitive Services environment. This tutorial shows you how to install SynapseML and how to create your Spark cluster in Databricks. +1. After you create a new notebook in Azure Databricks, copy the **Shared code** below and paste into a new cell in your notebook. +1. Choose a service sample, below, and copy paste it into a second new cell in your notebook. +1. Replace any of the service subscription key placeholders with your own key. +1. Choose the run button (triangle icon) in the upper right corner of the cell, then select **Run Cell**. +1. View results in a table below the cell. + +## Shared code + +To get started, we'll need to add this code to the project: + + +```python +from pyspark.sql.functions import udf, col +from synapse.ml.io.http import HTTPTransformer, http_udf +from requests import Request +from pyspark.sql.functions import lit +from pyspark.ml import PipelineModel +from pyspark.sql.functions import col +import os + +``` + + +```python +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() + from notebookutils.mssparkutils.credentials import getSecret + os.environ['ANOMALY_API_KEY'] = getSecret( + "mmlspark-keys", "anomaly-api-key") + os.environ['TEXT_API_KEY'] = getSecret("mmlspark-keys", "mmlspark-cs-key") + os.environ['BING_IMAGE_SEARCH_KEY'] = getSecret( + "mmlspark-keys", "mmlspark-bing-search-key") + os.environ['VISION_API_KEY'] = getSecret( + "mmlspark-keys", "mmlspark-cs-key") + os.environ['AZURE_SEARCH_KEY'] = getSecret( + "mmlspark-keys", "azure-search-key") +``` + + +```python +from synapse.ml.cognitive import * + +# A general Cognitive Services key for Text Analytics, Computer Vision and Form Recognizer (or use separate keys that belong to each service) +service_key = os.environ["COGNITIVE_SERVICE_KEY"] +# A Bing Search v7 subscription key +bing_search_key = os.environ["BING_IMAGE_SEARCH_KEY"] +# An Anomaly Dectector subscription key +anomaly_key = os.environ["ANOMALY_API_KEY"] +# A Translator subscription key +translator_key = os.environ["TRANSLATOR_KEY"] +``` + +## Text Analytics sample + +The [Text Analytics](https://azure.microsoft.com/en-us/services/cognitive-services/text-analytics/) service provides several algorithms for extracting intelligent insights from text. For example, we can find the sentiment of given input text. The service will return a score between 0.0 and 1.0 where low scores indicate negative sentiment and high score indicates positive sentiment. This sample uses three simple sentences and returns the sentiment for each. + + +```python +# Create a dataframe that's tied to it's column names +df = spark.createDataFrame([ + ("I am so happy today, its sunny!", "en-US"), + ("I am frustrated by this rush hour traffic", "en-US"), + ("The cognitive services on spark aint bad", "en-US"), +], ["text", "language"]) + +# Run the Text Analytics service with options +sentiment = (TextSentiment() + .setTextCol("text") + .setLocation("eastus") + .setSubscriptionKey(service_key) + .setOutputCol("sentiment") + .setErrorCol("error") + .setLanguageCol("language")) + +# Show the results of your text query in a table format +display(sentiment.transform(df).select("text", col( + "sentiment")[0].getItem("sentiment").alias("sentiment"))) +``` + +## Healthcare Analytics Sample + + +```python +df = spark.createDataFrame([ + ("20mg of ibuprofen twice a day",), + ("1tsp of Tylenol every 4 hours",), + ("6-drops of Vitamin B-12 every evening",)], ["text"]) + +healthcare = (HealthcareSDK() + .setSubscriptionKey(service_key) + .setLocation("eastus") + .setLanguage("en") + .setOutputCol("response")) + +display(healthcare.transform(df)) +``` + +## Translator sample +[Translator](https://azure.microsoft.com/en-us/services/cognitive-services/translator/) is a cloud-based machine translation service and is part of the Azure Cognitive Services family of cognitive APIs used to build intelligent apps. Translator is easy to integrate in your applications, websites, tools, and solutions. It allows you to add multi-language user experiences in 90 languages and dialects and can be used for text translation with any operating system. In this sample, we do a simple text translation by providing the sentences you want to translate and target languages you want to translate to. + + +```python +from pyspark.sql.functions import col, flatten + +# Create a dataframe including sentences you want to translate +df = spark.createDataFrame([ + (["Hello, what is your name?", "Bye"],) +], ["text",]) + +# Run the Translator service with options +translate = (Translate() + .setSubscriptionKey(translator_key) + .setLocation("eastus") + .setTextCol("text") + .setToLanguage(["zh-Hans"]) + .setOutputCol("translation")) + +# Show the results of the translation. +display(translate + .transform(df) + .withColumn("translation", flatten(col("translation.translations"))) + .withColumn("translation", col("translation.text")) + .select("translation")) +``` + +## Form Recognizer sample +[Form Recognizer](https://azure.microsoft.com/en-us/services/form-recognizer/) is a part of Azure Applied AI Services that lets you build automated data processing software using machine learning technology. Identify and extract text, key/value pairs, selection marks, tables, and structure from your documents—the service outputs structured data that includes the relationships in the original file, bounding boxes, confidence and more. In this sample, we analyze a business card image and extract its information into structured data. + + +```python +from pyspark.sql.functions import col, explode + +# Create a dataframe containing the source files +imageDf = spark.createDataFrame([ + ("https://mmlspark.blob.core.windows.net/datasets/FormRecognizer/business_card.jpg",) +], ["source",]) + +# Run the Form Recognizer service +analyzeBusinessCards = (AnalyzeBusinessCards() + .setSubscriptionKey(service_key) + .setLocation("eastus") + .setImageUrlCol("source") + .setOutputCol("businessCards")) + +# Show the results of recognition. +display(analyzeBusinessCards + .transform(imageDf) + .withColumn("documents", explode(col("businessCards.analyzeResult.documentResults.fields"))) + .select("source", "documents")) +``` + +## Computer Vision sample + +[Computer Vision](https://azure.microsoft.com/en-us/services/cognitive-services/computer-vision/) analyzes images to identify structure such as faces, objects, and natural-language descriptions. In this sample, we tag a list of images. Tags are one-word descriptions of things in the image like recognizable objects, people, scenery, and actions. + + +```python +# Create a dataframe with the image URLs +df = spark.createDataFrame([ + ("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-sample-data-files/master/ComputerVision/Images/objects.jpg", ), + ("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-sample-data-files/master/ComputerVision/Images/dog.jpg", ), + ("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-sample-data-files/master/ComputerVision/Images/house.jpg", ) +], ["image", ]) + +# Run the Computer Vision service. Analyze Image extracts infortmation from/about the images. +analysis = (AnalyzeImage() + .setLocation("eastus") + .setSubscriptionKey(service_key) + .setVisualFeatures(["Categories", "Color", "Description", "Faces", "Objects", "Tags"]) + .setOutputCol("analysis_results") + .setImageUrlCol("image") + .setErrorCol("error")) + +# Show the results of what you wanted to pull out of the images. +display(analysis.transform(df).select( + "image", "analysis_results.description.tags")) + +``` + +## Bing Image Search sample + +[Bing Image Search](https://azure.microsoft.com/en-us/services/cognitive-services/bing-image-search-api/) searches the web to retrieve images related to a user's natural language query. In this sample, we use a text query that looks for images with quotes. It returns a list of image URLs that contain photos related to our query. + + +```python +# Number of images Bing will return per query +imgsPerBatch = 10 +# A list of offsets, used to page into the search results +offsets = [(i*imgsPerBatch,) for i in range(100)] +# Since web content is our data, we create a dataframe with options on that data: offsets +bingParameters = spark.createDataFrame(offsets, ["offset"]) + +# Run the Bing Image Search service with our text query +bingSearch = (BingImageSearch() + .setSubscriptionKey(bing_search_key) + .setOffsetCol("offset") + .setQuery("Martin Luther King Jr. quotes") + .setCount(imgsPerBatch) + .setOutputCol("images")) + +# Transformer that extracts and flattens the richly structured output of Bing Image Search into a simple URL column +getUrls = BingImageSearch.getUrlTransformer("images", "url") + +# This displays the full results returned, uncomment to use +# display(bingSearch.transform(bingParameters)) + +# Since we have two services, they are put into a pipeline +pipeline = PipelineModel(stages=[bingSearch, getUrls]) + +# Show the results of your search: image URLs +display(pipeline.transform(bingParameters)) + +``` + +## Speech-to-Text sample +The [Speech-to-text](https://azure.microsoft.com/en-us/services/cognitive-services/speech-services/) service converts streams or files of spoken audio to text. In this sample, we transcribe one audio file. + + +```python +# Create a dataframe with our audio URLs, tied to the column called "url" +df = spark.createDataFrame([("https://mmlspark.blob.core.windows.net/datasets/Speech/audio2.wav",) + ], ["url"]) + +# Run the Speech-to-text service to translate the audio into text +speech_to_text = (SpeechToTextSDK() + .setSubscriptionKey(service_key) + .setLocation("eastus") + .setOutputCol("text") + .setAudioDataCol("url") + .setLanguage("en-US") + .setProfanity("Masked")) + +# Show the results of the translation +display(speech_to_text.transform(df).select("url", "text.DisplayText")) + +``` + +## Anomaly Detector sample + +[Anomaly Detector](https://azure.microsoft.com/en-us/services/cognitive-services/anomaly-detector/) is great for detecting irregularities in your time series data. In this sample, we use the service to find anomalies in the entire time series. + + +```python +# Create a dataframe with the point data that Anomaly Detector requires +df = spark.createDataFrame([ + ("1972-01-01T00:00:00Z", 826.0), + ("1972-02-01T00:00:00Z", 799.0), + ("1972-03-01T00:00:00Z", 890.0), + ("1972-04-01T00:00:00Z", 900.0), + ("1972-05-01T00:00:00Z", 766.0), + ("1972-06-01T00:00:00Z", 805.0), + ("1972-07-01T00:00:00Z", 821.0), + ("1972-08-01T00:00:00Z", 20000.0), + ("1972-09-01T00:00:00Z", 883.0), + ("1972-10-01T00:00:00Z", 898.0), + ("1972-11-01T00:00:00Z", 957.0), + ("1972-12-01T00:00:00Z", 924.0), + ("1973-01-01T00:00:00Z", 881.0), + ("1973-02-01T00:00:00Z", 837.0), + ("1973-03-01T00:00:00Z", 9000.0) +], ["timestamp", "value"]).withColumn("group", lit("series1")) + +# Run the Anomaly Detector service to look for irregular data +anamoly_detector = (SimpleDetectAnomalies() + .setSubscriptionKey(anomaly_key) + .setLocation("eastus") + .setTimestampCol("timestamp") + .setValueCol("value") + .setOutputCol("anomalies") + .setGroupbyCol("group") + .setGranularity("monthly")) + +# Show the full results of the analysis with the anomalies marked as "True" +display(anamoly_detector.transform(df).select( + "timestamp", "value", "anomalies.isAnomaly")) +``` + +## Arbitrary web APIs + +With HTTP on Spark, any web service can be used in your big data pipeline. In this example, we use the [World Bank API](http://api.worldbank.org/v2/country/) to get information about various countries around the world. + + +```python +# Use any requests from the python requests library + +def world_bank_request(country): + return Request("GET", "http://api.worldbank.org/v2/country/{}?format=json".format(country)) + + +# Create a dataframe with spcificies which countries we want data on +df = (spark.createDataFrame([("br",), ("usa",)], ["country"]) + .withColumn("request", http_udf(world_bank_request)(col("country")))) + +# Much faster for big data because of the concurrency :) +client = (HTTPTransformer() + .setConcurrency(3) + .setInputCol("request") + .setOutputCol("response")) + +# Get the body of the response + + +def get_response_body(resp): + return resp.entity.content.decode() + + +# Show the details of the country data returned +display(client.transform(df) + .select("country", udf(get_response_body)(col("response")) + .alias("response"))) + +``` + +## Azure Cognitive search sample + +In this example, we show how you can enrich data using Cognitive Skills and write to an Azure Search Index using SynapseML. + + +```python +VISION_API_KEY = os.environ['VISION_API_KEY'] +AZURE_SEARCH_KEY = os.environ['AZURE_SEARCH_KEY'] +search_service = "mmlspark-azure-search" +search_index = "test-33467690" + +df = spark.createDataFrame([("upload", "0", "https://mmlspark.blob.core.windows.net/datasets/DSIR/test1.jpg"), + ("upload", "1", "https://mmlspark.blob.core.windows.net/datasets/DSIR/test2.jpg")], + ["searchAction", "id", "url"]) + +tdf = AnalyzeImage()\ + .setSubscriptionKey(VISION_API_KEY)\ + .setLocation("eastus")\ + .setImageUrlCol("url")\ + .setOutputCol("analyzed")\ + .setErrorCol("errors")\ + .setVisualFeatures(["Categories", "Tags", "Description", "Faces", "ImageType", "Color", "Adult"])\ + .transform(df).select("*", "analyzed.*")\ + .drop("errors", "analyzed") + +tdf.writeToAzureSearch(subscriptionKey=AZURE_SEARCH_KEY, + actionCol="searchAction", + serviceName=search_service, + indexName=search_index, + keyCol="id") + +``` diff --git a/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Predictive Maintenance.md b/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Predictive Maintenance.md new file mode 100644 index 0000000000..6cb72b18b2 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/cognitive_services/CognitiveServices - Predictive Maintenance.md @@ -0,0 +1,146 @@ +--- +title: CognitiveServices - Predictive Maintenance +hide_title: true +status: stable +--- +# Recipe: Predictive maintenance with the Cognitive Services for Big Data + +This recipe shows how you can use Azure Synapse Analytics and Cognitive Services on Apache Spark for predictive maintenance of IoT devices. We'll follow along with the [CosmosDB and Synapse Link](https://github.com/Azure-Samples/cosmosdb-synapse-link-samples) sample. To keep things simple, in this recipe we'll read the data straight from a CSV file rather than getting streamed data through CosmosDB and Synapse Link. We strongly encourage you to look over the Synapse Link sample. + +## Hypothetical scenario + +The hypothetical scenario is a Power Plant, where IoT devices are monitoring [steam turbines](https://en.wikipedia.org/wiki/Steam_turbine). The IoTSignals collection has Revolutions per minute (RPM) and Megawatts (MW) data for each turbine. Signals from steam turbines are being analyzed and anomalous signals are detected. + +There could be outliers in the data in random frequency. In those situations, RPM values will go up and MW output will go down, for circuit protection. The idea is to see the data varying at the same time, but with different signals. + +## Prerequisites + +* An Azure subscription - [Create one for free](https://azure.microsoft.com/en-us/free/) +* [Azure Synapse workspace](https://docs.microsoft.com/en-us/azure/synapse-analytics/get-started-create-workspace) configured with a [serverless Apache Spark pool](https://docs.microsoft.com/en-us/azure/synapse-analytics/get-started-analyze-spark) + +## Setup + +### Create an Anomaly Detector resource + +Azure Cognitive Services are represented by Azure resources that you subscribe to. Create a resource for Translator using the [Azure portal](https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Clinux) or [Azure CLI](https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-apis-create-account-cli?tabs=linux). You can also: + +- View an existing resource in the [Azure portal](https://portal.azure.com/). + +Make note of the endpoint and the key for this resource, you'll need it in this guide. + +## Enter your service keys + +Let's start by adding your key and location. + + +``` +import os + +service_key = os.environ["ANOMALY_API_KEY"] # Paste your anomaly detector key here +location = "westus2" # Paste your anomaly detector location here + +assert (service_key is not None) +``` + +## Read data into a DataFrame + +Next, let's read the IoTSignals file into a DataFrame. Open a new notebook in your Synapse workspace and create a DataFrame from the file. + + +``` +df_signals = spark.read.csv("wasbs://publicwasb@mmlspark.blob.core.windows.net/iot/IoTSignals.csv", header=True, inferSchema=True) +``` + +### Run anomaly detection using Cognitive Services on Spark + +The goal is to find instances where the signals from the IoT devices were outputting anomalous values so that we can see when something is going wrong and do predictive maintenance. To do that, let's use Anomaly Detector on Spark: + + +``` +from pyspark.sql.functions import col, struct +from synapse.ml.cognitive import SimpleDetectAnomalies +from synapse.ml.core.spark import FluentAPI + +detector = (SimpleDetectAnomalies() + .setSubscriptionKey(service_key) + .setLocation(location) + .setOutputCol("anomalies") + .setGroupbyCol("grouping") + .setSensitivity(95) + .setGranularity("secondly")) + +df_anomaly = (df_signals + .where(col("unitSymbol") == 'RPM') + .withColumn("timestamp", col("dateTime").cast("string")) + .withColumn("value", col("measureValue").cast("double")) + .withColumn("grouping", struct("deviceId")) + .mlTransform(detector)).cache() + +df_anomaly.createOrReplaceTempView('df_anomaly') +``` + +Let's take a look at the data: + + +``` +df_anomaly.select("timestamp","value","deviceId","anomalies.isAnomaly").show(3) + +``` + +This cell should yield a result that looks like: + +| timestamp | value | deviceId | isAnomaly | +|:--------------------|--------:|:-----------|:------------| +| 2020-05-01 18:33:51 | 3174 | dev-7 | False | +| 2020-05-01 18:33:52 | 2976 | dev-7 | False | +| 2020-05-01 18:33:53 | 2714 | dev-7 | False | + +## Visualize anomalies for one of the devices + +IoTSignals.csv has signals from multiple IoT devices. We'll focus on a specific device and visualize anomalous outputs from the device. + + +``` +df_anomaly_single_device = spark.sql(""" +select + timestamp, + measureValue, + anomalies.expectedValue, + anomalies.expectedValue + anomalies.upperMargin as expectedUpperValue, + anomalies.expectedValue - anomalies.lowerMargin as expectedLowerValue, + case when anomalies.isAnomaly=true then 1 else 0 end as isAnomaly +from + df_anomaly +where deviceid = 'dev-1' and timestamp < '2020-04-29' +order by timestamp +limit 200""") +``` + +Now that we have created a dataframe that represents the anomalies for a particular device, we can visualize these anomalies: + + +``` +import matplotlib.pyplot as plt +from pyspark.sql.functions import col + +adf = df_anomaly_single_device.toPandas() +adf_subset = df_anomaly_single_device.where(col("isAnomaly") == 1).toPandas() + +plt.figure(figsize=(23,8)) +plt.plot(adf['timestamp'],adf['expectedUpperValue'], color='darkred', linestyle='solid', linewidth=0.25, label='UpperMargin') +plt.plot(adf['timestamp'],adf['expectedValue'], color='darkgreen', linestyle='solid', linewidth=2, label='Expected Value') +plt.plot(adf['timestamp'],adf['measureValue'], 'b', color='royalblue', linestyle='dotted', linewidth=2, label='Actual') +plt.plot(adf['timestamp'],adf['expectedLowerValue'], color='black', linestyle='solid', linewidth=0.25, label='Lower Margin') +plt.plot(adf_subset['timestamp'],adf_subset['measureValue'], 'ro', label = 'Anomaly') +plt.legend() +plt.title('RPM Anomalies with Confidence Intervals') +plt.show() +``` + +If successful, your output will look like this: + +![Anomaly Detector Plot](https://github.com/MicrosoftDocs/azure-docs/raw/master/articles/cognitive-services/big-data/media/anomaly-output.png) + +## Next steps + +Learn how to do predictive maintenance at scale with Azure Cognitive Services, Azure Synapse Analytics, and Azure CosmosDB. For more information, see the full sample on [GitHub](https://github.com/Azure-Samples/cosmosdb-synapse-link-samples). diff --git a/website/versioned_docs/version-0.9.5/features/cognitive_services/GeospatialServices - Flooding Risk.md b/website/versioned_docs/version-0.9.5/features/cognitive_services/GeospatialServices - Flooding Risk.md new file mode 100644 index 0000000000..6a1bd54772 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/cognitive_services/GeospatialServices - Flooding Risk.md @@ -0,0 +1,144 @@ +--- +title: GeospatialServices - Flooding Risk +hide_title: true +status: stable +--- +# Visualizing Customer addresses on a flood plane + +King County (WA) publishes flood plain data as well as tax parcel data. We can use the addresses in the tax parcel data and use the geocoder to calculate coordinates. Using this coordinates and the flood plain data we can enrich out dataset with a flag indicating whether the house is in a flood zone or not. + +The following data has been sourced from King County's Open data portal. [_Link_](https://data.kingcounty.gov/) +1. [Address Data](https://mmlspark.blob.core.windows.net/publicwasb/maps/KingCountyAddress.csv) +1. [Flood plains](https://mmlspark.blob.core.windows.net/publicwasb/maps/KingCountyFloodPlains.geojson) + +For this demonstration, please follow the instructions on setting up your azure maps account from the overview notebook. + +## Prerequisites +1. Upload the flood plains data as map data to your creator resource + + +```python +import os +import requests +import json +import time + +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() + +# Azure Maps account key +azureMapsKey = os.environ["AZURE_MAPS_KEY"] #Replace this with your azure maps key + +# Creator Geo prefix +# for this example, assuming that the creator resource is created in `EAST US 2`. +atlas_geo_prefix = "us" + +# Load flood plains data +flood_plain_geojson = requests.get("https://mmlspark.blob.core.windows.net/publicwasb/maps/KingCountyFloodPlains.geojson").content + +# Upload this flood plains data to your maps/creator account. This is a Long-Running async operation and takes approximately 15~30 seconds to complete +r= requests.post(f'https://{atlas_geo_prefix}.atlas.microsoft.com/mapData/upload?api-version=1.0&dataFormat=geojson&subscription-key={azureMapsKey}', + json=json.loads(flood_plain_geojson)) + +# Location header points to the long running operation resource. +long_running_operation = r.headers.get('location') + +time.sleep(30) # Just some assurance + +# After 15~30 seconds, query for the operation status +print(f"Status Code: {r.status_code}, Long Running Operation: {long_running_operation}") + +# Once the above operation returns a HTTP 201, get the user_data_id of the flood plains data, you uploaded to your map account. +user_data_id_resource_url = json.loads(requests.get(f'{long_running_operation}&subscription-key={azureMapsKey}').content)['resourceLocation'] +user_data_id = json.loads(requests.get(f'{user_data_id_resource_url}&subscription-key={azureMapsKey}').content)['udid'] +``` + +Now that we have the flood plains data setup in our maps account, we can use the `CheckPointInPolygon` function to check if a location `(lat,lon)` coordinate is in a flood zone. + +### Load address data: + + +```python +data = spark.read\ + .option("header", "true")\ + .csv("wasbs://publicwasb@mmlspark.blob.core.windows.net/maps/KingCountyAddress.csv") + +# Visualize incoming schema +print("Schema:") +data.printSchema() + +# Choose a subset of the data for this example +subset_data = data.limit(50) +display(subset_data) +``` + +### Wire-up the Address Geocoder + +We will use the address geocoder to enrich the dataset with location coordinates of the addresses. + + +```python +from pyspark.sql.functions import col +from synapse.ml.cognitive import * +from synapse.ml.stages import FixedMiniBatchTransformer, FlattenBatch +from synapse.ml.geospatial import * + +def extract_location_fields(df): + # Use this function to select only lat/lon columns into the dataframe + return df.select(col("*"), + col("output.response.results").getItem(0).getField("position").getField("lat").alias("Latitude"), + col("output.response.results").getItem(0).getField("position").getField("lon").alias("Longitude") + ).drop("output") + + +# Azure Maps geocoder to enhance the dataframe with location data +geocoder = (AddressGeocoder() + .setSubscriptionKey(azureMapsKey) + .setAddressCol("FullAddress") + .setOutputCol("output")) + +# Set up a fixed mini batch transformer to geocode addresses +batched_dataframe = geocoder.transform(FixedMiniBatchTransformer().setBatchSize(10).transform(subset_data.coalesce(1))) +geocoded_addresses = extract_location_fields(FlattenBatch().transform(batched_dataframe)) + +# Display the results +display(geocoded_addresses) +``` + +Now that we have geocoded the addresses, we can now use the `CheckPointInPolygon` function to check if a property is in a flood zone or not. + +### Setup Check Point In Polygon + + +```python +def extract_point_in_polygon_result_fields(df): + # Use this function to select only lat/lon columns into the dataframe + return df.select(col("*"), + col("output.result.pointInPolygons").alias("In Polygon"), + col("output.result.intersectingGeometries").alias("Intersecting Polygons") + ).drop("output") + + +check_point_in_polygon = (CheckPointInPolygon() + .setSubscriptionKey(azureMapsKey) + .setGeography(atlas_geo_prefix) + .setUserDataIdentifier(user_data_id) + .setLatitudeCol("Latitude") + .setLongitudeCol("Longitude") + .setOutputCol("output")) + + +flood_plain_addresses = extract_point_in_polygon_result_fields(check_point_in_polygon.transform(geocoded_addresses)) + +# Display the results +display(flood_plain_addresses) +``` + +### Cleanup Uploaded User Data (Optional) +You can (optionally) delete the uploaded geojson polygon. + + +```python +res = requests.delete(f"https://{atlas_geo_prefix}.atlas.microsoft.com/mapData/{user_data_id}?api-version=1.0&subscription-key={azureMapsKey}") +``` diff --git a/website/versioned_docs/version-0.9.5/features/cognitive_services/GeospatialServices - Overview.md b/website/versioned_docs/version-0.9.5/features/cognitive_services/GeospatialServices - Overview.md new file mode 100644 index 0000000000..5f493fa2bd --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/cognitive_services/GeospatialServices - Overview.md @@ -0,0 +1,232 @@ +--- +title: GeospatialServices - Overview +hide_title: true +status: stable +--- + + +# Azure Maps Geospatial Services + +[Microsoft Azure Maps ](https://azure.microsoft.com/en-us/services/azure-maps/) provides developers from all industries with powerful geospatial capabilities. Those geospatial capabilities are packed with the freshest mapping data. Azure Maps is available for web, mobile (iOS and Android), Microsoft Power BI, Microsoft Power Apps and Microsoft Synapse. Azure Maps is an Open API compliant set of REST APIs. The following are only a high-level overview of the services which Azure Maps offers - Maps, Search, Routing, Traffic, Weather, Time Zones, Geolocation, Geofencing, Map Data, Creator, and Spatial Operations. + +## Usage + +### Geocode addresses +[**Address Geocoding**](https://docs.microsoft.com/en-us/rest/api/maps/search/post-search-address-batch) The Search Address Batch API sends batches of queries to Search Address API using just a single API call. This API geocodes text addresses or partial addresses and the geocoding search index will be queried for everything above the street level data. **Note** that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc. + +### Reverse Geocode Coordinates +[**Reverse Geocoding**](https://docs.microsoft.com/en-us/rest/api/maps/search/post-search-address-reverse-batch) The Search Address Reverse Batch API sends batches of queries to Search Address Reverse API using just a single API call. This API takes in location coordinates and translates them into human readable street addresses. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. + +### Get Point In Polygon +[**Get Point in Polygon**](https://docs.microsoft.com/en-us/rest/api/maps/spatial/get-point-in-polygon) This API returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons can we pre-created by using the [**Data Upload API**](https://docs.microsoft.com/en-us/rest/api/maps/data/upload-preview) referenced by a unique udid. + +## Prerequisites + +1. Sign into the [Azure Portal](https://portal.azure.com) and create an Azure Maps account by following these [instructions](https://docs.microsoft.com/en-us/azure/azure-maps/how-to-manage-account-keys#create-a-new-account). +1. Once the Maps account is created, provision a Maps Creator Resource by following these [instructions](https://docs.microsoft.com/en-us/azure/azure-maps/how-to-manage-creator#create-creator-resource). Creator is a [geographically scoped service](https://docs.microsoft.com/en-us/azure/azure-maps/creator-geographic-scope). Pick appropriate location while provisioning the creator resource. +1. Follow these [instructions](https://docs.microsoft.com/en-us/azure/cognitive-services/big-data/getting-started#create-an-apache-spark-cluster) to set up your Azure Databricks environment and install SynapseML. +1. After you create a new notebook in Azure Databricks, copy the **Shared code** below and paste into a new cell in your notebook. +1. Choose a service sample, below, and copy paste it into a second new cell in your notebook. +1. Replace the `AZUREMAPS_API_KEY` placeholders with your own [Maps account key](https://docs.microsoft.com/en-us/azure/azure-maps/how-to-manage-authentication#view-authentication-details). +1. Choose the run button (triangle icon) in the upper right corner of the cell, then select **Run Cell**. +1. View results in a table below the cell. + +## Shared code + +To get started, we'll need to add this code to the project: + + +```python +from pyspark.sql.functions import udf, col +from pyspark.sql.types import StructType,StructField, DoubleType +import requests +from pyspark.sql.functions import lit +from pyspark.ml import PipelineModel +from pyspark.sql.functions import col +import os +``` + + +```python +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() + from notebookutils.mssparkutils.credentials import getSecret + os.environ['AZURE_MAPS_KEY'] = getSecret( + "mmlspark-keys", "azuremaps-api-key") +``` + + +```python +from synapse.ml.cognitive import * +from synapse.ml.geospatial import * + +# An Azure Maps account key +azureMapsKey = os.environ["AZURE_MAPS_KEY"] +``` + +## Geocoding sample + +The azure maps geocoder sends batches of queries to the [Search Address API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress). The API limits the batch size to 10000 queries per request. + + +```python +from synapse.ml.stages import FixedMiniBatchTransformer, FlattenBatch + +df = spark.createDataFrame([ + ("One, Microsoft Way, Redmond",), + ("400 Broad St, Seattle",), + ("350 5th Ave, New York",), + ("Pike Pl, Seattle",), + ("Champ de Mars, 5 Avenue Anatole France, 75007 Paris",) +], ["address",]) + + +def extract_location_fields(df): + # Use this function to select only lat/lon columns into the dataframe + return df.select(col("*"), + col("output.response.results").getItem(0).getField("position").getField("lat").alias("Latitude"), + col("output.response.results").getItem(0).getField("position").getField("lon").alias("Longitude") + ).drop("output") + +# Run the Azure Maps geocoder to enhance the data with location data +geocoder = (AddressGeocoder() + .setSubscriptionKey(azureMapsKey) + .setAddressCol("address") + .setOutputCol("output")) + +# Show the results of your text query in a table format +display(extract_location_fields(geocoder.transform(FixedMiniBatchTransformer().setBatchSize(10).transform(df)))) +``` + +## Reverse Geocoding sample + +The azure maps reverse geocoder sends batches of queries to the [Search Address Reverse API](https://docs.microsoft.com/en-us/rest/api/maps/search/get-search-address-reverse) using just a single API call. The API allows caller to batch up to 10,000 queries per request + + +```python +# Create a dataframe that's tied to it's column names +df = spark.createDataFrame((( + (48.858561, 2.294911), + (47.639765, -122.127896), + (47.621028, -122.348170), + (47.734012, -122.102737) + )), StructType([StructField("lat", DoubleType()), StructField("lon", DoubleType())])) + +# Run the Azure Maps geocoder to enhance the data with location data +rev_geocoder = (ReverseAddressGeocoder() + .setSubscriptionKey(azureMapsKey) + .setLatitudeCol("lat") + .setLongitudeCol("lon") + .setOutputCol("output")) + +# Show the results of your text query in a table format + +display(rev_geocoder.transform(FixedMiniBatchTransformer().setBatchSize(10).transform(df)).select(col("*"), + col("output.response.addresses").getItem(0).getField("address").getField("freeformAddress").alias("In Polygon"), + col("output.response.addresses").getItem(0).getField("address").getField("country").alias("Intersecting Polygons") + ).drop("output")) + +``` + +## Check Point In Polygon sample + +This API returns a boolean value indicating whether a point is inside a set of polygons. The polygon can be added to you creator account using the [**Data Upload API**](https://docs.microsoft.com/en-us/rest/api/maps/data/upload-preview). The API then returnrs a unique udid to reference the polygon. + +### Setup geojson Polygons in your azure maps creator account + +Based on where the creator resource was provisioned, we need to prefix the appropriate geography code to the azure maps URL. In this example, the assumption is that the creator resource was provisioned in `East US 2` Location and hence we pick `us` as our geo prefix. + + +```python +import requests +import time +import json + +# Choose a geography, you want your data to reside in. +# Allowed values +# us => North American datacenters +# eu -> European datacenters +url_geo_prefix = 'us' + +# Upload a geojson with polygons in them +r= requests.post(f'https://{url_geo_prefix}.atlas.microsoft.com/mapData/upload?api-version=1.0&dataFormat=geojson&subscription-key={azureMapsKey}', + json= { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": { "geometryId": "test_geometry" }, + "geometry": { + "type": "Polygon", + "coordinates":[ + [ + [ + -122.14290618896484, + 47.67856488312544 + ], + [ + -122.03956604003906, + 47.67856488312544 + ], + [ + -122.03956604003906, + 47.7483271435476 + ], + [ + -122.14290618896484, + 47.7483271435476 + ], + [ + -122.14290618896484, + 47.67856488312544 + ] + ] + ] + } + } + ] + }) + +long_running_operation = r.headers.get('location') +time.sleep(30) # Sometimes this may take upto 30 seconds +print(f"Status Code: {r.status_code}, Long Running Operation: {long_running_operation}") +# This Operation completes in approximately 5 ~ 15 seconds +user_data_id_resource_url = json.loads(requests.get(f'{long_running_operation}&subscription-key={azureMapsKey}').content)['resourceLocation'] +user_data_id = json.loads(requests.get(f'{user_data_id_resource_url}&subscription-key={azureMapsKey}').content)['udid'] +``` + +### Use the function to check if point is in polygon + + +```python +# Create a dataframe that's tied to it's column names +df = spark.createDataFrame((( + (48.858561, 2.294911), + (47.639765, -122.127896), + (47.621028, -122.348170), + (47.734012, -122.102737) + )), StructType([StructField("lat", DoubleType()), StructField("lon", DoubleType())])) + +# Run the Azure Maps geocoder to enhance the data with location data +check_point_in_polygon = (CheckPointInPolygon() + .setSubscriptionKey(azureMapsKey) + .setGeography(url_geo_prefix) + .setUserDataIdentifier(user_data_id) + .setLatitudeCol("lat") + .setLongitudeCol("lon") + .setOutputCol("output")) + +# Show the results of your text query in a table format +display(check_point_in_polygon.transform(df).select(col("*"), + col("output.result.pointInPolygons").alias("In Polygon"), + col("output.result.intersectingGeometries").alias("Intersecting Polygons") + ).drop("output")) +``` + +### Cleanup + + +```python +res = requests.delete(f"https://{url_geo_prefix}.atlas.microsoft.com/mapData/{user_data_id}?api-version=1.0&subscription-key={azureMapsKey}") +``` diff --git a/website/versioned_docs/version-0.9.5/features/lightgbm/LightGBM - Overview.md b/website/versioned_docs/version-0.9.5/features/lightgbm/LightGBM - Overview.md new file mode 100644 index 0000000000..e7f0c1a278 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/lightgbm/LightGBM - Overview.md @@ -0,0 +1,281 @@ +--- +title: LightGBM - Overview +hide_title: true +status: stable +--- +# LightGBM + +[LightGBM](https://github.com/Microsoft/LightGBM) is an open-source, +distributed, high-performance gradient boosting (GBDT, GBRT, GBM, or +MART) framework. This framework specializes in creating high-quality and +GPU enabled decision tree algorithms for ranking, classification, and +many other machine learning tasks. LightGBM is part of Microsoft's +[DMTK](http://github.com/microsoft/dmtk) project. + +### Advantages of LightGBM + +- **Composability**: LightGBM models can be incorporated into existing + SparkML Pipelines, and used for batch, streaming, and serving + workloads. +- **Performance**: LightGBM on Spark is 10-30% faster than SparkML on + the Higgs dataset, and achieves a 15% increase in AUC. [Parallel + experiments](https://github.com/Microsoft/LightGBM/blob/master/docs/Experiments.rst#parallel-experiment) + have verified that LightGBM can achieve a linear speed-up by using + multiple machines for training in specific settings. +- **Functionality**: LightGBM offers a wide array of [tunable + parameters](https://github.com/Microsoft/LightGBM/blob/master/docs/Parameters.rst), + that one can use to customize their decision tree system. LightGBM on + Spark also supports new types of problems such as quantile regression. +- **Cross platform** LightGBM on Spark is available on Spark, PySpark, and SparklyR + +### LightGBM Usage: + +- LightGBMClassifier: used for building classification models. For example, to predict whether a company will bankrupt or not, we could build a binary classification model with LightGBMClassifier. +- LightGBMRegressor: used for building regression models. For example, to predict the house price, we could build a regression model with LightGBMRegressor. +- LightGBMRanker: used for building ranking models. For example, to predict website searching result relevance, we could build a ranking model with LightGBMRanker. + +## Bankruptcy Prediction with LightGBM Classifier + + + +In this example, we use LightGBM to build a classification model in order to predict bankruptcy. + +#### Read dataset + + +```python +import os + +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() +``` + + +```python +df = spark.read.format("csv")\ + .option("header", True)\ + .option("inferSchema", True)\ + .load("wasbs://publicwasb@mmlspark.blob.core.windows.net/company_bankruptcy_prediction_data.csv") +# print dataset size +print("records read: " + str(df.count())) +print("Schema: ") +df.printSchema() +``` + + +```python +display(df) +``` + +#### Split the dataset into train and test + + +```python +train, test = df.randomSplit([0.85, 0.15], seed=1) +``` + +#### Add featurizer to convert features to vector + + +```python +from pyspark.ml.feature import VectorAssembler +feature_cols = df.columns[1:] +featurizer = VectorAssembler( + inputCols=feature_cols, + outputCol='features' +) +train_data = featurizer.transform(train)['Bankrupt?', 'features'] +test_data = featurizer.transform(test)['Bankrupt?', 'features'] +``` + +#### Check if the data is unbalanced + + +```python +display(train_data.groupBy("Bankrupt?").count()) +``` + +#### Model Training + + +```python +from synapse.ml.lightgbm import LightGBMClassifier +model = LightGBMClassifier(objective="binary", featuresCol="features", labelCol="Bankrupt?", isUnbalance=True) +``` + + +```python +model = model.fit(train_data) +``` + +By calling "saveNativeModel", it allows you to extract the underlying lightGBM model for fast deployment after you train on Spark. + + +```python +from synapse.ml.lightgbm import LightGBMClassificationModel + +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + model.saveNativeModel("/models/lgbmclassifier.model") + model = LightGBMClassificationModel.loadNativeModelFromFile("/models/lgbmclassifier.model") +else: + model.saveNativeModel("/lgbmclassifier.model") + model = LightGBMClassificationModel.loadNativeModelFromFile("/lgbmclassifier.model") + +``` + +#### Feature Importances Visualization + + +```python +import pandas as pd +import matplotlib.pyplot as plt + +feature_importances = model.getFeatureImportances() +fi = pd.Series(feature_importances,index = feature_cols) +fi = fi.sort_values(ascending = True) +f_index = fi.index +f_values = fi.values + +# print feature importances +print ('f_index:',f_index) +print ('f_values:',f_values) + +# plot +x_index = list(range(len(fi))) +x_index = [x/len(fi) for x in x_index] +plt.rcParams['figure.figsize'] = (20,20) +plt.barh(x_index,f_values,height = 0.028 ,align="center",color = 'tan',tick_label=f_index) +plt.xlabel('importances') +plt.ylabel('features') +plt.show() +``` + +#### Model Prediction + + +```python +predictions = model.transform(test_data) +predictions.limit(10).toPandas() +``` + + +```python +from synapse.ml.train import ComputeModelStatistics +metrics = ComputeModelStatistics(evaluationMetric="classification", labelCol='Bankrupt?', scoredLabelsCol='prediction').transform(predictions) +display(metrics) +``` + +## Quantile Regression for Drug Discovery with LightGBMRegressor + + + +In this example, we show how to use LightGBM to build a simple regression model. + +#### Read dataset + + +```python +triazines = spark.read.format("libsvm")\ + .load("wasbs://publicwasb@mmlspark.blob.core.windows.net/triazines.scale.svmlight") +``` + + +```python +# print some basic info +print("records read: " + str(triazines.count())) +print("Schema: ") +triazines.printSchema() +display(triazines.limit(10)) +``` + +#### Split dataset into train and test + + +```python +train, test = triazines.randomSplit([0.85, 0.15], seed=1) +``` + +#### Model Training + + +```python +from synapse.ml.lightgbm import LightGBMRegressor +model = LightGBMRegressor(objective='quantile', + alpha=0.2, + learningRate=0.3, + numLeaves=31).fit(train) +``` + + +```python +print(model.getFeatureImportances()) +``` + +#### Model Prediction + + +```python +scoredData = model.transform(test) +display(scoredData) +``` + + +```python +from synapse.ml.train import ComputeModelStatistics +metrics = ComputeModelStatistics(evaluationMetric='regression', + labelCol='label', + scoresCol='prediction') \ + .transform(scoredData) +display(metrics) +``` + +## LightGBM Ranker + +#### Read dataset + + +```python +df = spark.read.format("parquet").load("wasbs://publicwasb@mmlspark.blob.core.windows.net/lightGBMRanker_train.parquet") +# print some basic info +print("records read: " + str(df.count())) +print("Schema: ") +df.printSchema() +display(df.limit(10)) +``` + +#### Model Training + + +```python +from synapse.ml.lightgbm import LightGBMRanker + +features_col = 'features' +query_col = 'query' +label_col = 'labels' +lgbm_ranker = LightGBMRanker(labelCol=label_col, + featuresCol=features_col, + groupCol=query_col, + predictionCol='preds', + leafPredictionCol='leafPreds', + featuresShapCol='importances', + repartitionByGroupingColumn=True, + numLeaves=32, + numIterations=200, + evalAt=[1,3,5], + metric='ndcg') +``` + + +```python +lgbm_ranker_model = lgbm_ranker.fit(df) +``` + +#### Model Prediction + + +```python +dt = spark.read.format("parquet").load("wasbs://publicwasb@mmlspark.blob.core.windows.net/lightGBMRanker_test.parquet") +predictions = lgbm_ranker_model.transform(dt) +predictions.limit(10).toPandas() +``` diff --git a/website/versioned_docs/version-0.9.5/features/lightgbm/about.md b/website/versioned_docs/version-0.9.5/features/lightgbm/about.md new file mode 100644 index 0000000000..1cc9150ad0 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/lightgbm/about.md @@ -0,0 +1,98 @@ +--- +title: LightGBM +hide_title: true +sidebar_label: About +--- + +# LightGBM on Apache Spark + +### LightGBM + +[LightGBM](https://github.com/Microsoft/LightGBM) is an open-source, +distributed, high-performance gradient boosting (GBDT, GBRT, GBM, or +MART) framework. This framework specializes in creating high-quality and +GPU enabled decision tree algorithms for ranking, classification, and +many other machine learning tasks. LightGBM is part of Microsoft's +[DMTK](http://github.com/microsoft/dmtk) project. + +### Advantages of LightGBM + +- **Composability**: LightGBM models can be incorporated into existing + SparkML Pipelines, and used for batch, streaming, and serving + workloads. +- **Performance**: LightGBM on Spark is 10-30% faster than SparkML on + the Higgs dataset, and achieves a 15% increase in AUC. [Parallel + experiments](https://github.com/Microsoft/LightGBM/blob/master/docs/Experiments.rst#parallel-experiment) + have verified that LightGBM can achieve a linear speed-up by using + multiple machines for training in specific settings. +- **Functionality**: LightGBM offers a wide array of [tunable + parameters](https://github.com/Microsoft/LightGBM/blob/master/docs/Parameters.rst), + that one can use to customize their decision tree system. LightGBM on + Spark also supports new types of problems such as quantile regression. +- **Cross platform** LightGBM on Spark is available on Spark, PySpark, and SparklyR + +### Usage + +In PySpark, you can run the `LightGBMClassifier` via: + +```python +from synapse.ml.lightgbm import LightGBMClassifier +model = LightGBMClassifier(learningRate=0.3, + numIterations=100, + numLeaves=31).fit(train) +``` + +Similarly, you can run the `LightGBMRegressor` by setting the +`application` and `alpha` parameters: + +```python +from synapse.ml.lightgbm import LightGBMRegressor +model = LightGBMRegressor(application='quantile', + alpha=0.3, + learningRate=0.3, + numIterations=100, + numLeaves=31).fit(train) +``` + +For an end to end application, check out the LightGBM [notebook +example](../LightGBM%20-%20Overview). + +### Architecture + +LightGBM on Spark uses the Simple Wrapper and Interface Generator (SWIG) +to add Java support for LightGBM. These Java Binding use the Java Native +Interface call into the [distributed C++ +API](https://github.com/Microsoft/LightGBM/blob/master/include/LightGBM/c_api.h). + +We initialize LightGBM by calling +[`LGBM_NetworkInit`](https://github.com/Microsoft/LightGBM/blob/master/include/LightGBM/c_api.h) +with the Spark executors within a MapPartitions call. We then pass each +workers partitions into LightGBM to create the in-memory distributed +dataset for LightGBM. We can then train LightGBM to produce a model +that can then be used for inference. + +The `LightGBMClassifier` and `LightGBMRegressor` use the SparkML API, +inherit from the same base classes, integrate with SparkML pipelines, +and can be tuned with [SparkML's cross +validators](https://spark.apache.org/docs/latest/ml-tuning.html). + +Models built can be saved as SparkML pipeline with native LightGBM model +using `saveNativeModel()`. Additionally, they are fully compatible with [PMML](https://en.wikipedia.org/wiki/Predictive_Model_Markup_Language) and +can be converted to PMML format through the +[JPMML-SparkML-LightGBM](https://github.com/alipay/jpmml-sparkml-lightgbm) plugin. + +### Barrier Execution Mode + +By default LightGBM uses regular spark paradigm for launching tasks and communicates with the driver to coordinate task execution. +The driver thread aggregates all task host:port information and then communicates the full list back to the workers in order for NetworkInit to be called. +This requires the driver to know how many tasks there are, and if the expected number of tasks is different from actual this will cause the initialization to deadlock. +There is a new UseBarrierExecutionMode flag, which when activated uses the barrier() stage to block all tasks. +The barrier execution mode simplifies the logic to aggregate host:port information across all tasks. +To use it in scala, you can call setUseBarrierExecutionMode(true), for example: + + val lgbm = new LightGBMClassifier() + .setLabelCol(labelColumn) + .setObjective(binaryObjective) + .setUseBarrierExecutionMode(true) + ... + diff --git a/website/versioned_docs/version-0.9.5/features/onnx/ONNX - Inference on Spark.md b/website/versioned_docs/version-0.9.5/features/onnx/ONNX - Inference on Spark.md new file mode 100644 index 0000000000..9f3230f761 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/onnx/ONNX - Inference on Spark.md @@ -0,0 +1,126 @@ +--- +title: ONNX - Inference on Spark +hide_title: true +status: stable +--- +## ONNX Inference on Spark + +In this example, we will train a LightGBM model, convert the model to ONNX format and use the converted model to infer some testing data on Spark. + +Python dependencies: + +- onnxmltools==1.7.0 +- lightgbm==3.2.1 + + +Load training data + + +```python +df = spark.read.format("csv")\ + .option("header", True)\ + .option("inferSchema", True)\ + .load("wasbs://publicwasb@mmlspark.blob.core.windows.net/company_bankruptcy_prediction_data.csv") + +display(df) +``` + +Use LightGBM to train a model + + +```python +from pyspark.ml.feature import VectorAssembler +from synapse.ml.lightgbm import LightGBMClassifier + +feature_cols = df.columns[1:] +featurizer = VectorAssembler( + inputCols=feature_cols, + outputCol='features' +) + +train_data = featurizer.transform(df)['Bankrupt?', 'features'] + +model = ( + LightGBMClassifier(featuresCol="features", labelCol="Bankrupt?") + .setEarlyStoppingRound(300) + .setLambdaL1(0.5) + .setNumIterations(1000) + .setNumThreads(-1) + .setMaxDeltaStep(0.5) + .setNumLeaves(31) + .setMaxDepth(-1) + .setBaggingFraction(0.7) + .setFeatureFraction(0.7) + .setBaggingFreq(2) + .setObjective("binary") + .setIsUnbalance(True) + .setMinSumHessianInLeaf(20) + .setMinGainToSplit(0.01) +) + +model = model.fit(train_data) +``` + +Export the trained model to a LightGBM booster, convert it to ONNX format. + + +```python +import lightgbm as lgb +from lightgbm import Booster, LGBMClassifier + +def convertModel(lgbm_model: LGBMClassifier or Booster, input_size: int) -> bytes: + from onnxmltools.convert import convert_lightgbm + from onnxconverter_common.data_types import FloatTensorType + initial_types = [("input", FloatTensorType([-1, input_size]))] + onnx_model = convert_lightgbm(lgbm_model, initial_types=initial_types, target_opset=9) + return onnx_model.SerializeToString() + +booster_model_str = model.getLightGBMBooster().modelStr().get() +booster = lgb.Booster(model_str=booster_model_str) +model_payload_ml = convertModel(booster, len(df.columns) - 1) +``` + +Load the ONNX payload into an `ONNXModel`, and inspect the model inputs and outputs. + + +```python +from synapse.ml.onnx import ONNXModel + +onnx_ml = ONNXModel().setModelPayload(model_payload_ml) + +print("Model inputs:" + str(onnx_ml.getModelInputs())) +print("Model outputs:" + str(onnx_ml.getModelOutputs())) +``` + +Map the model input to the input dataframe's column name (FeedDict), and map the output dataframe's column names to the model outputs (FetchDict). + + +```python +onnx_ml = ( + onnx_ml + .setDeviceType("CPU") + .setFeedDict({"input": "features"}) + .setFetchDict({"probability": "probabilities", "prediction": "label"}) + .setMiniBatchSize(5000) +) +``` + +Create some testing data and transform the data through the ONNX model. + + +```python +from pyspark.ml.feature import VectorAssembler +import pandas as pd +import numpy as np + +n = 1000 * 1000 +m = 95 +test = np.random.rand(n, m) +testPdf = pd.DataFrame(test) +cols = list(map(str, testPdf.columns)) +testDf = spark.createDataFrame(testPdf) +testDf = testDf.union(testDf).repartition(200) +testDf = VectorAssembler().setInputCols(cols).setOutputCol("features").transform(testDf).drop(*cols).cache() + +display(onnx_ml.transform(testDf)) +``` diff --git a/website/versioned_docs/version-0.9.5/features/onnx/about.md b/website/versioned_docs/version-0.9.5/features/onnx/about.md new file mode 100644 index 0000000000..e9946a0203 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/onnx/about.md @@ -0,0 +1,49 @@ +--- +title: ONNX model inferencing on Spark +hide_title: true +sidebar_label: About +description: Learn how to use the ONNX model transformer to run inference for an ONNX model on Spark. +--- + +# ONNX model inferencing on Spark + +## ONNX + +[ONNX](https://onnx.ai/) is an open format to represent both deep learning and traditional machine learning models. With ONNX, AI developers can more easily move models between state-of-the-art tools and choose the combination that is best for them. + +SynapseML now includes a Spark transformer to bring an trained ONNX model to Apache Spark, so you can run inference on your data with Spark's large-scale data processing power. + +## Usage + +1. Create a `com.microsoft.azure.synapse.ml.onnx.ONNXModel` object and use `setModelLocation` or `setModelPayload` to load the ONNX model. + + For example: + + ```scala + val onnx = new ONNXModel().setModelLocation("/path/to/model.onnx") + ``` + +2. Use ONNX visualization tool (e.g. [Netron](https://netron.app/)) to inspect the ONNX model's input and output nodes. + + ![Screenshot that illustrates an ONNX model's input and output nodes](https://mmlspark.blob.core.windows.net/graphics/ONNXModelInputsOutputs.png) + +3. Set the parameters properly to the `ONNXModel` object. + + The `com.microsoft.azure.synapse.ml.onnx.ONNXModel` class provides a set of parameters to control the behavior of the inference. + + | Parameter | Description | Default Value | + |:------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------| + | feedDict | Map the ONNX model's expected input node names to the input DataFrame's column names. Make sure the input DataFrame's column schema matches with the corresponding input's shape of the ONNX model. For example, an image classification model may have an input node of shape `[1, 3, 224, 224]` with type Float. It is assumed that the first dimension (1) is the batch size. Then the input DataFrame's corresponding column's type should be `ArrayType(ArrayType(ArrayType(FloatType)))`. | None | + | fetchDict | Map the output DataFrame's column names to the ONNX model's output node names. | None | + | miniBatcher | Specify the MiniBatcher to use. | `FixedMiniBatchTransformer` with batch size 10 | + | softMaxDict | A map between output DataFrame columns, where the value column will be computed from taking the softmax of the key column. If the 'rawPrediction' column contains logits outputs, then one can set softMaxDict to `Map("rawPrediction" -> "probability")` to obtain the probability outputs. | None | + | argMaxDict | A map between output DataFrame columns, where the value column will be computed from taking the argmax of the key column. This can be used to convert probability or logits output to the predicted label. | None | + | deviceType | Specify a device type the model inference runs on. Supported types are: CPU or CUDA. If not specified, auto detection will be used. | None | + | optimizationLevel | Specify the [optimization level](https://onnxruntime.ai/docs/resources/graph-optimizations.html#graph-optimization-levels) for the ONNX graph optimizations. Supported values are: `NO_OPT`, `BASIC_OPT`, `EXTENDED_OPT`, `ALL_OPT`. | `ALL_OPT` | + +4. Call `transform` method to run inference on the input DataFrame. + +## Example + +- [Interpretability - Image Explainers](../../responsible_ai/Interpretability%20-%20Image%20Explainers) +- [ONNX - Inference on Spark](../ONNX%20-%20Inference%20on%20Spark) diff --git a/website/versioned_docs/version-0.9.5/features/opencv/OpenCV - Pipeline Image Transformations.md b/website/versioned_docs/version-0.9.5/features/opencv/OpenCV - Pipeline Image Transformations.md new file mode 100644 index 0000000000..5ebffe7f2e --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/opencv/OpenCV - Pipeline Image Transformations.md @@ -0,0 +1,150 @@ +--- +title: OpenCV - Pipeline Image Transformations +hide_title: true +status: stable +--- +## OpenCV - Pipeline Image Transformations + +This example shows how to manipulate the collection of images. +First, the images are downloaded to the local directory. +Second, they are copied to your cluster's attached HDFS. + +The images are loaded from the directory (for fast prototyping, consider loading a fraction of +images). Inside the dataframe, each image is a single field in the image column. The image has +sub-fields (path, height, width, OpenCV type and OpenCV bytes). + + +```python +import os +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() + +import synapse.ml +import numpy as np +from synapse.ml.opencv import toNDArray +from synapse.ml.io import * + +imageDir = "wasbs://publicwasb@mmlspark.blob.core.windows.net/sampleImages" +images = spark.read.image().load(imageDir).cache() +images.printSchema() +print(images.count()) +``` + +We can also alternatively stream the images with a similiar api. +Check the [Structured Streaming Programming Guide](https://spark.apache.org/docs/latest/structured-streaming-programming-guide.html) +for more details on streaming. + + +```python +import time +imageStream = spark.readStream.image().load(imageDir) +query = imageStream.select("image.height").writeStream.format("memory").queryName("heights").start() +time.sleep(3) +print("Streaming query activity: {}".format(query.isActive)) +``` + +Wait a few seconds and then try querying for the images below. +Note that when streaming a directory of images that already exists it will +consume all images in a single batch. If one were to move images into the +directory, the streaming engine would pick up on them and send them as +another batch. + + +```python +heights = spark.sql("select * from heights") +print("Streamed {} heights".format(heights.count())) +``` + +After we have streamed the images we can stop the query: + + +```python +from py4j.protocol import Py4JJavaError +try: + query.stop() +except Py4JJavaError as e: + print(e) +``` + +When collected from the *DataFrame*, the image data are stored in a *Row*, which is Spark's way +to represent structures (in the current example, each dataframe row has a single Image, which +itself is a Row). It is possible to address image fields by name and use `toNDArray()` helper +function to convert the image into numpy array for further manipulations. + + +```python +from PIL import Image +import matplotlib.pyplot as plt +data = images.take(3) # take first three rows of the dataframe +im = data[2][0] # the image is in the first column of a given row + +print("image type: {}, number of fields: {}".format(type(im), len(im))) +print("image path: {}".format(im.origin)) +print("height: {}, width: {}, OpenCV type: {}".format(im.height, im.width, im.mode)) + +arr = toNDArray(im) # convert to numpy array +print(images.count()) +plt.imshow(Image.fromarray(arr, "RGB")) # display the image inside notebook + +``` + +Use `ImageTransformer` for the basic image manipulation: resizing, cropping, etc. +Internally, operations are pipelined and backed by OpenCV implementation. + + +```python +from synapse.ml.opencv import ImageTransformer + +tr = (ImageTransformer() # images are resized and then cropped + .setOutputCol("transformed") + .resize(size=(200, 200)) + .crop(0, 0, height = 180, width = 180) ) + +small = tr.transform(images).select("transformed") + +im = small.take(3)[2][0] # take third image +plt.imshow(Image.fromarray(toNDArray(im), "RGB")) # display the image inside notebook +``` + +For the advanced image manipulations, use Spark UDFs. +The SynapseML package provides conversion function between *Spark Row* and +*ndarray* image representations. + + +```python +from pyspark.sql.functions import udf +from synapse.ml.opencv import ImageSchema, toNDArray, toImage + +def u(row): + array = toNDArray(row) # convert Image to numpy ndarray[height, width, 3] + array[:,:,2] = 0 + return toImage(array) # numpy array back to Spark Row structure + +noBlueUDF = udf(u,ImageSchema) + +noblue = small.withColumn("noblue", noBlueUDF(small["transformed"])).select("noblue") + +im = noblue.take(3)[2][0] # take second image +plt.imshow(Image.fromarray(toNDArray(im), "RGB")) # display the image inside notebook +``` + +Images could be unrolled into the dense 1D vectors suitable for CNTK evaluation. + + +```python +from synapse.ml.image import UnrollImage + +unroller = UnrollImage().setInputCol("noblue").setOutputCol("unrolled") + +unrolled = unroller.transform(noblue).select("unrolled") + +vector = unrolled.take(1)[0][0] +print(type(vector)) +len(vector.toArray()) +``` + + +```python + +``` diff --git a/website/versioned_docs/version-0.9.5/features/other/AzureSearchIndex - Met Artworks.md b/website/versioned_docs/version-0.9.5/features/other/AzureSearchIndex - Met Artworks.md new file mode 100644 index 0000000000..c32e6e57fc --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/other/AzureSearchIndex - Met Artworks.md @@ -0,0 +1,90 @@ +--- +title: AzureSearchIndex - Met Artworks +hide_title: true +status: stable +--- +

Creating a searchable Art Database with The MET's open-access collection

+ +In this example, we show how you can enrich data using Cognitive Skills and write to an Azure Search Index using SynapseML. We use a subset of The MET's open-access collection and enrich it by passing it through 'Describe Image' and a custom 'Image Similarity' skill. The results are then written to a searchable index. + + +```python +import os, sys, time, json, requests +from pyspark.ml import Transformer, Estimator, Pipeline +from pyspark.ml.feature import SQLTransformer +from pyspark.sql.functions import lit, udf, col, split +``` + + +```python +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() + from notebookutils.mssparkutils.credentials import getSecret + os.environ['VISION_API_KEY'] = getSecret("mmlspark-keys", "mmlspark-cs-key") + os.environ['AZURE_SEARCH_KEY'] = getSecret("mmlspark-keys", "mmlspark-azure-search-key") +``` + + +```python +VISION_API_KEY = os.environ['VISION_API_KEY'] +AZURE_SEARCH_KEY = os.environ['AZURE_SEARCH_KEY'] +search_service = "mmlspark-azure-search" +search_index = "test" +``` + + +```python +data = spark.read\ + .format("csv")\ + .option("header", True)\ + .load("wasbs://publicwasb@mmlspark.blob.core.windows.net/metartworks_sample.csv")\ + .withColumn("searchAction", lit("upload"))\ + .withColumn("Neighbors", split(col("Neighbors"), ",").cast("array"))\ + .withColumn("Tags", split(col("Tags"), ",").cast("array"))\ + .limit(25) +``` + + + + +```python +from synapse.ml.cognitive import AnalyzeImage +from synapse.ml.stages import SelectColumns + +#define pipeline +describeImage = (AnalyzeImage() + .setSubscriptionKey(VISION_API_KEY) + .setLocation("eastus") + .setImageUrlCol("PrimaryImageUrl") + .setOutputCol("RawImageDescription") + .setErrorCol("Errors") + .setVisualFeatures(["Categories", "Description", "Faces", "ImageType", "Color", "Adult"]) + .setConcurrency(5)) + +df2 = describeImage.transform(data)\ + .select("*", "RawImageDescription.*").drop("Errors", "RawImageDescription") +``` + + + +Before writing the results to a Search Index, you must define a schema which must specify the name, type, and attributes of each field in your index. Refer [Create a basic index in Azure Search](https://docs.microsoft.com/en-us/azure/search/search-what-is-an-index) for more information. + + +```python +from synapse.ml.cognitive import * +df2.writeToAzureSearch( + subscriptionKey=AZURE_SEARCH_KEY, + actionCol="searchAction", + serviceName=search_service, + indexName=search_index, + keyCol="ObjectID") +``` + +The Search Index can be queried using the [Azure Search REST API](https://docs.microsoft.com/rest/api/searchservice/) by sending GET or POST requests and specifying query parameters that give the criteria for selecting matching documents. For more information on querying refer [Query your Azure Search index using the REST API](https://docs.microsoft.com/en-us/rest/api/searchservice/Search-Documents) + + +```python +url = 'https://{}.search.windows.net/indexes/{}/docs/search?api-version=2019-05-06'.format(search_service, search_index) +requests.post(url, json={"search": "Glass"}, headers = {"api-key": AZURE_SEARCH_KEY}).json() +``` diff --git a/website/versioned_docs/version-0.9.5/features/other/ConditionalKNN - Exploring Art Across Cultures.md b/website/versioned_docs/version-0.9.5/features/other/ConditionalKNN - Exploring Art Across Cultures.md new file mode 100644 index 0000000000..16751ba790 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/other/ConditionalKNN - Exploring Art Across Cultures.md @@ -0,0 +1,222 @@ +--- +title: ConditionalKNN - Exploring Art Across Cultures +hide_title: true +status: stable +--- +# Exploring Art across Culture and Medium with Fast, Conditional, k-Nearest Neighbors + + + +This notebook serves as a guideline for match-finding via k-nearest-neighbors. In the code below, we will set up code that allows queries involving cultures and mediums of art amassed from the Metropolitan Museum of Art in NYC and the Rijksmuseum in Amsterdam. + +### Overview of the BallTree +The structure functioning behind the kNN model is a BallTree, which is a recursive binary tree where each node (or "ball") contains a partition of the points of data to be queried. Building a BallTree involves assigning data points to the "ball" whose center they are closest to (with respect to a certain specified feature), resulting in a structure that allows binary-tree-like traversal and lends itself to finding k-nearest neighbors at a BallTree leaf. + +#### Setup +Import necessary Python libraries and prepare dataset. + + +```python +from pyspark.sql.types import BooleanType +from pyspark.sql.types import * +from pyspark.ml.feature import Normalizer +from pyspark.sql.functions import lit, array, array_contains, udf, col, struct +from synapse.ml.nn import ConditionalKNN, ConditionalKNNModel +from PIL import Image +from io import BytesIO + +import requests +import numpy as np +import matplotlib.pyplot as plt + +import os + +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() + +``` + +Our dataset comes from a table containing artwork information from both the Met and Rijks museums. The schema is as follows: + +- **id**: A unique identifier for a piece of art + - Sample Met id: *388395* + - Sample Rijks id: *SK-A-2344* +- **Title**: Art piece title, as written in the museum's database +- **Artist**: Art piece artist, as written in the museum's database +- **Thumbnail_Url**: Location of a JPEG thumbnail of the art piece +- **Image_Url** Location of an image of the art piece hosted on the Met/Rijks website +- **Culture**: Category of culture that the art piece falls under + - Sample culture categories: *latin american*, *egyptian*, etc +- **Classification**: Category of medium that the art piece falls under + - Sample medium categories: *woodwork*, *paintings*, etc +- **Museum_Page**: Link to the work of art on the Met/Rijks website +- **Norm_Features**: Embedding of the art piece image +- **Museum**: Specifies which museum the piece originated from + + +```python +# loads the dataset and the two trained CKNN models for querying by medium and culture +df = spark.read.parquet( + "wasbs://publicwasb@mmlspark.blob.core.windows.net/met_and_rijks.parquet") +display(df.drop("Norm_Features")) + +``` + +#### Define categories to be queried on +We will be using two kNN models: one for culture, and one for medium. The categories for each grouping are defined below. + + +```python +# mediums = ['prints', 'drawings', 'ceramics', 'textiles', 'paintings', "musical instruments","glass", 'accessories', 'photographs', "metalwork", +# "sculptures", "weapons", "stone", "precious", "paper", "woodwork", "leatherwork", "uncategorized"] + +mediums = ['paintings', 'glass', 'ceramics'] + +# cultures = ['african (general)', 'american', 'ancient american', 'ancient asian', 'ancient european', 'ancient middle-eastern', 'asian (general)', +# 'austrian', 'belgian', 'british', 'chinese', 'czech', 'dutch', 'egyptian']#, 'european (general)', 'french', 'german', 'greek', +# 'iranian', 'italian', 'japanese', 'latin american', 'middle eastern', 'roman', 'russian', 'south asian', 'southeast asian', +# 'spanish', 'swiss', 'various'] + +cultures = ['japanese', 'american', 'african (general)'] + +# Uncomment the above for more robust and large scale searches! + +classes = cultures + mediums + +medium_set = set(mediums) +culture_set = set(cultures) +selected_ids = {"AK-RBK-17525-2", "AK-MAK-1204", "AK-RAK-2015-2-9"} + +small_df = df.where(udf(lambda medium, culture, id_val: (medium in medium_set) or ( + culture in culture_set) or (id_val in selected_ids), BooleanType())("Classification", "Culture", "id")) + +small_df.count() + +``` + +### Define and fit ConditionalKNN models +Below, we create ConditionalKNN models for both the medium and culture columns; each model takes in an output column, features column (feature vector), values column (cell values under the output column), and label column (the quality that the respective KNN is conditioned on). + + +```python +medium_cknn = (ConditionalKNN() + .setOutputCol("Matches") + .setFeaturesCol("Norm_Features") + .setValuesCol("Thumbnail_Url") + .setLabelCol("Classification") + .fit(small_df)) +``` + + +```python +culture_cknn = (ConditionalKNN() + .setOutputCol("Matches") + .setFeaturesCol("Norm_Features") + .setValuesCol("Thumbnail_Url") + .setLabelCol("Culture") + .fit(small_df)) + +``` + +#### Define matching and visualizing methods + +After the intial dataset and category setup, we prepare methods that will query and visualize the conditional kNN's results. + +`addMatches()` will create a Dataframe with a handful of matches per category. + + +```python +def add_matches(classes, cknn, df): + results = df + for label in classes: + results = (cknn.transform(results.withColumn("conditioner", array(lit(label)))) + .withColumnRenamed("Matches", "Matches_{}".format(label))) + return results +``` + +`plot_urls()` calls `plot_img` to visualize top matches for each category into a grid. + + +```python +def plot_img(axis, url, title): + try: + response = requests.get(url) + img = Image.open(BytesIO(response.content)).convert('RGB') + axis.imshow(img, aspect="equal") + except: + pass + if title is not None: + axis.set_title(title, fontsize=4) + axis.axis("off") + + +def plot_urls(url_arr, titles, filename): + nx, ny = url_arr.shape + + plt.figure(figsize=(nx*5, ny*5), dpi=1600) + fig, axes = plt.subplots(ny, nx) + + # reshape required in the case of 1 image query + if len(axes.shape) == 1: + axes = axes.reshape(1, -1) + + for i in range(nx): + for j in range(ny): + if j == 0: + plot_img(axes[j, i], url_arr[i, j], titles[i]) + else: + plot_img(axes[j, i], url_arr[i, j], None) + + plt.savefig(filename, dpi=1600) # saves the results as a PNG + + display(plt.show()) +``` + +### Putting it all together +Below, we define `test_all()` to take in the data, CKNN models, the art id values to query on, and the file path to save the output visualization to. The medium and culture models were previously trained and loaded. + + +```python +# main method to test a particular dataset with two CKNN models and a set of art IDs, saving the result to filename.png + +def test_all(data, cknn_medium, cknn_culture, test_ids, root): + is_nice_obj = udf(lambda obj: obj in test_ids, BooleanType()) + test_df = data.where(is_nice_obj("id")) + + results_df_medium = add_matches(mediums, cknn_medium, test_df) + results_df_culture = add_matches(cultures, cknn_culture, results_df_medium) + + results = results_df_culture.collect() + + original_urls = [row["Thumbnail_Url"] for row in results] + + culture_urls = [[row["Matches_{}".format( + label)][0]["value"] for row in results] for label in cultures] + culture_url_arr = np.array([original_urls] + culture_urls)[:, :] + plot_urls(culture_url_arr, ["Original"] + + cultures, root + "matches_by_culture.png") + + medium_urls = [[row["Matches_{}".format( + label)][0]["value"] for row in results] for label in mediums] + medium_url_arr = np.array([original_urls] + medium_urls)[:, :] + plot_urls(medium_url_arr, ["Original"] + + mediums, root + "matches_by_medium.png") + + return results_df_culture + +``` + +### Demo +The following cell performs batched queries given desired image IDs and a filename to save the visualization. + + + + + +```python +# sample query +result_df = test_all(small_df, medium_cknn, culture_cknn, + selected_ids, root=".") + +``` diff --git a/website/versioned_docs/version-0.9.5/features/other/CyberML - Anomalous Access Detection.md b/website/versioned_docs/version-0.9.5/features/other/CyberML - Anomalous Access Detection.md new file mode 100644 index 0000000000..85d631c331 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/other/CyberML - Anomalous Access Detection.md @@ -0,0 +1,329 @@ +--- +title: CyberML - Anomalous Access Detection +hide_title: true +status: stable +--- +# CyberML - Anomalous Access Detection + +Here we demonstrate a novel CyberML model which can learn user access patterns and then automatically detect anomalous user access based on learned behavior. +The model internally uses Collaborative Filtering for Implicit Feedback as published here: http://yifanhu.net/PUB/cf.pdf +and is based on Apache Spark's implementation of this: https://spark.apache.org/docs/2.2.0/ml-collaborative-filtering.html. + +This notebook demonstrates a usage example of Anomalous Resource Access model. +All the model requires is a dataset in which there are 'users' which access 'resources'. +The model is based on Collaborative Filtering and it uses Machine Learning to learn access patterns of users and resources. +When a user accesses a resource which is outside of the user's learned profile then this access recieves a high anomaly score. + +In this notebook we provide a usage example and a synthetic dataset in which there are 3 departments: +(1) Finance, (2) HR and (3) Engineering. +In the training data users access only a subset of resources from their own departments. +To evaluate the model we use two datasets. +The first contains access patterns unseen during training in which users access resources within their departments (again, resources they didn't access during training but within their department). +The latter contains users accessing resources from outside their department. +We then use the model to assign anomaly scores expecting that the first get low anomaly scores and the latter recieve high anomaly scores. +This is what this example demonstrates. + +Note: the data does NOT contain information about departments, this information is implictly learned by the model by analyzing the access patterns. + +# Create an Azure Databricks cluster and install the following libs + +1. In Cluster Libraries install from library source Maven: +Coordinates: com.microsoft.azure:synapseml_2.12:0.9.5 +Repository: https://mmlspark.azureedge.net/maven + +2. In Cluster Libraries install from PyPI the library called plotly + +# Setup & Initialization + + +``` +# this is used to produce the synthetic dataset for this test +from synapse.ml.cyber.dataset import DataFactory + +# the access anomalies model generator +from synapse.ml.cyber.anomaly.collaborative_filtering import AccessAnomaly + +from pyspark.sql import functions as f, types as t +``` + + +``` +spark.sparkContext.setCheckpointDir('dbfs:/checkpoint_path/') +``` + +# Loadup datasets + + +``` +factory = DataFactory( + num_hr_users = 25, + num_hr_resources = 50, + num_fin_users = 35, + num_fin_resources = 75, + num_eng_users = 15, + num_eng_resources = 25, + single_component = True +) + +training_pdf = factory.create_clustered_training_data(ratio=0.4) + +# a tenant id is used when independant datasets originate from different tenants, in this example we set all tenants-ids to the same value +training_df = spark.createDataFrame(training_pdf).withColumn('tenant_id', f.lit(0)) +ingroup_df = spark.createDataFrame(factory.create_clustered_intra_test_data(training_pdf)).withColumn('tenant_id', f.lit(0)) +outgroup_df = spark.createDataFrame(factory.create_clustered_inter_test_data()).withColumn('tenant_id', f.lit(0)) +``` + + +``` +training_df.show() +``` + + +``` +print(training_df.count()) +print(ingroup_df.count()) +print(outgroup_df.count()) +``` + +# Model setup & training + + +``` +access_anomaly = AccessAnomaly( + tenantCol='tenant_id', + userCol='user', + resCol='res', + likelihoodCol='likelihood', + maxIter=1000 +) +``` + + +``` +model = access_anomaly.fit(training_df) +``` + +# Apply model & show result stats + + +``` +ingroup_scored_df = model.transform(ingroup_df) +``` + + +``` +ingroup_scored_df.agg( + f.min('anomaly_score').alias('min_anomaly_score'), + f.max('anomaly_score').alias('max_anomaly_score'), + f.mean('anomaly_score').alias('mean_anomaly_score'), + f.stddev('anomaly_score').alias('stddev_anomaly_score'), +).show() +``` + + +``` +outgroup_scored_df = model.transform(outgroup_df) +``` + + +``` +outgroup_scored_df.agg( + f.min('anomaly_score').alias('min_anomaly_score'), + f.max('anomaly_score').alias('max_anomaly_score'), + f.mean('anomaly_score').alias('mean_anomaly_score'), + f.stddev('anomaly_score').alias('stddev_anomaly_score'), +).show() +``` + +# Examine results + + +``` +# +# Select a subset of results to send to Log Analytics +# + +full_res_df = outgroup_scored_df.orderBy(f.desc('anomaly_score')).cache() + +from pyspark.sql.window import Window + +w = Window.partitionBy( + 'tenant_id', + 'user', + 'res' + ).orderBy( + f.desc('anomaly_score') + ) + +# select values above threshold +results_above_threshold = full_res_df.filter(full_res_df.anomaly_score > 1.0) + +# get distinct resource/user and corresponding timestamp and highest score +results_to_la = results_above_threshold.withColumn( + 'index', f.row_number().over(w) + ).orderBy( + f.desc('anomaly_score') + ).select( + 'tenant_id', + f.col('user'), + f.col('res'), + 'anomaly_score' + ).where( + 'index == 1' + ).limit(100).cache() + +# add a fake timestamp to the results +results_to_la = results_to_la.withColumn('timestamp', f.current_timestamp()) + +display(results_to_la) +``` + +# Display all resource accesses by users with highest anomalous score + + +``` +from plotly import __version__ +from plotly.offline import download_plotlyjs, init_notebook_mode, plot, iplot, offline + +import numpy as np +import pandas as pd + +print (__version__) # requires version >= 1.9.0 + +# run plotly in offline mode +offline.init_notebook_mode() +``` + + +``` +#Find all server accesses of users with high predicted scores +# For display, limit to top 25 results +results_to_display = results_to_la.orderBy( + f.desc('anomaly_score') + ).limit(25).cache() +interesting_records = full_res_df.join(results_to_display, ['user'], 'left_semi') +non_anomalous_records = interesting_records.join(results_to_display, ['user', 'res'], 'left_anti') + +top_non_anomalous_records = non_anomalous_records.groupBy( + 'tenant_id', + 'user', + 'res' + ).agg( + f.count('*').alias('count'), + ).select( + f.col('tenant_id'), + f.col('user'), + f.col('res'), + 'count' + ) + +#pick only a subset of non-anomalous record for UI +w = Window.partitionBy( + 'tenant_id', + 'user', + ).orderBy( + f.desc('count') + ) + +# pick top non-anomalous set +top_non_anomalous_accesses = top_non_anomalous_records.withColumn( + 'index', f.row_number().over(w) + ).orderBy( + f.desc('count') + ).select( + 'tenant_id', + f.col('user'), + f.col('res'), + f.col('count') + ).where( + 'index in (1,2,3,4,5)' + ).limit(25) + +# add back anomalous record +fileShare_accesses = (top_non_anomalous_accesses + .select('user', 'res', 'count') + .union(results_to_display.select('user', 'res', f.lit(1).alias('count'))).cache()) +``` + + +``` +# get unique users and file shares +high_scores_df = fileShare_accesses.toPandas() +unique_arr = np.append(high_scores_df.user.unique(), high_scores_df.res.unique()) + +unique_df = pd.DataFrame(data = unique_arr, columns = ['name']) +unique_df['index'] = range(0, len(unique_df.index)) + +# create index for source & target and color for the normal accesses +normal_line_color = 'rgba(211, 211, 211, 0.8)' +anomolous_color = 'red' +x = pd.merge(high_scores_df, unique_df, how='left', left_on='user', right_on='name').drop(['name'], axis=1).rename(columns={'index' : 'userIndex'}) +all_access_index_df = pd.merge(x, unique_df, how='left', left_on='res', right_on='name').drop(['name'], axis=1).rename(columns={'index' : 'resIndex'}) +all_access_index_df['color'] = normal_line_color + +# results_to_display index, color and +y = results_to_display.toPandas().drop(['tenant_id', 'timestamp', 'anomaly_score'], axis=1) +y = pd.merge(y, unique_df, how='left', left_on='user', right_on='name').drop(['name'], axis=1).rename(columns={'index' : 'userIndex'}) +high_scores_index_df = pd.merge(y, unique_df, how='left', left_on='res', right_on='name').drop(['name'], axis=1).rename(columns={'index' : 'resIndex'}) +high_scores_index_df['count'] = 1 +high_scores_index_df['color'] = anomolous_color + +# substract 1 for the red entries in all_access df +hsi_df = high_scores_index_df[['user','res', 'count']].rename(columns={'count' : 'hsiCount'}) +all_access_updated_count_df = pd.merge(all_access_index_df, hsi_df, how='left', left_on=['user', 'res'], right_on=['user', 'res']) +all_access_updated_count_df['count'] = np.where(all_access_updated_count_df['hsiCount']==1, all_access_updated_count_df['count'] - 1, all_access_updated_count_df['count']) +all_access_updated_count_df = all_access_updated_count_df.loc[all_access_updated_count_df['count'] > 0] +all_access_updated_count_df = all_access_updated_count_df[['user','res', 'count', 'userIndex', 'resIndex', 'color']] + +# combine the two tables +frames = [all_access_updated_count_df, high_scores_index_df] +display_df = pd.concat(frames, sort=True) +# display_df.head() +``` + + +``` +data_trace = dict( + type='sankey', + domain = dict( + x = [0,1], + y = [0,1] + ), + orientation = "h", + valueformat = ".0f", + node = dict( + pad = 10, + thickness = 30, + line = dict( + color = "black", + width = 0 + ), + label = unique_df['name'].dropna(axis=0, how='any') + ), + link = dict( + source = display_df['userIndex'].dropna(axis=0, how='any'), + target = display_df['resIndex'].dropna(axis=0, how='any'), + value = display_df['count'].dropna(axis=0, how='any'), + color = display_df['color'].dropna(axis=0, how='any'), + ) +) + +layout = dict( + title = "All resources accessed by users with highest anomalous scores", + height = 772, + font = dict( + size = 10 + ), +) + +fig = dict(data=[data_trace], layout=layout) + +p = plot(fig, output_type='div') + +displayHTML(p) +``` + + +``` + +``` diff --git a/website/versioned_docs/version-0.9.5/features/other/DeepLearning - BiLSTM Medical Entity Extraction.md b/website/versioned_docs/version-0.9.5/features/other/DeepLearning - BiLSTM Medical Entity Extraction.md new file mode 100644 index 0000000000..d367ec0b58 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/other/DeepLearning - BiLSTM Medical Entity Extraction.md @@ -0,0 +1,232 @@ +--- +title: DeepLearning - BiLSTM Medical Entity Extraction +hide_title: true +status: stable +--- +## DeepLearning - BiLSTM Medical Entity Extraction + +In this tutorial we use a Bidirectional LSTM entity extractor from the synapseml +model downloader to extract entities from PubMed medical abstracts + +Our goal is to identify useful entities in a block of free-form text. This is a +nontrivial task because entities might be referenced in the text using variety of +synonymns, abbreviations, or formats. Our target output for this model is a set +of tags that specify what kind of entity is referenced. The model we use was +trained on a large dataset of publically tagged pubmed abstracts. An example +annotated sequence is given below, "O" represents no tag: + +|I-Chemical | O |I-Chemical | O | O |I-Chemical | O |I-Chemical | O | O | O | O |I-Disease |I-Disease| O | O | +|:---: |:---:|:---: |:---:|:---:|:---: |:---:|:---: |:---:|:---: |:---:|:---:|:---: |:---: |:---:|:---: | +|Baricitinib| , |Methotrexate| , | or |Baricitinib|Plus |Methotrexate| in |Patients|with |Early|Rheumatoid|Arthritis| Who |Had...| + + + + +```python +from synapse.ml.cntk import CNTKModel +from synapse.ml.downloader import ModelDownloader +from pyspark.sql.functions import udf, col +from pyspark.sql.types import IntegerType, ArrayType, FloatType, StringType +from pyspark.sql import Row + +from os.path import abspath, join +import numpy as np +from nltk.tokenize import sent_tokenize, word_tokenize +import os, tarfile, pickle +import urllib.request +import nltk +``` + +Get the model and extract the data. + + +```python +modelName = "BiLSTM" +modelDir = "models" +if not os.path.exists(modelDir): os.makedirs(modelDir) +d = ModelDownloader(spark, "dbfs:///" + modelDir) +modelSchema = d.downloadByName(modelName) +nltk.download("punkt", "/dbfs/nltkdata") +nltk.data.path.append("/dbfs/nltkdata") +``` + + +```python +modelName = "BiLSTM" +modelDir = abspath("models") +if not os.path.exists(modelDir): os.makedirs(modelDir) +d = ModelDownloader(spark, "file://" + modelDir) +modelSchema = d.downloadByName(modelName) +nltk.download("punkt") +``` + +Download the embeddings + +We use the nltk punkt sentence and word tokenizers and a set of embeddings trained on PubMed Articles + + +```python +wordEmbFileName = "WordEmbeddings_PubMed.pkl" +pickleFile = join(abspath("models"), wordEmbFileName) +if not os.path.isfile(pickleFile): + urllib.request.urlretrieve("https://mmlspark.blob.core.windows.net/datasets/" + wordEmbFileName, pickleFile) +``` + +Load the embeddings and create functions for encoding sentences + + +```python +pickleContent = pickle.load(open(pickleFile, "rb"), encoding="latin-1") +wordToIndex = pickleContent["word_to_index"] +wordvectors = pickleContent["wordvectors"] +classToEntity = pickleContent["class_to_entity"] + +nClasses = len(classToEntity) +nFeatures = wordvectors.shape[1] +maxSentenceLen = 613 +``` + + +```python +content = "Baricitinib, Methotrexate, or Baricitinib Plus Methotrexate in Patients with Early Rheumatoid\ + Arthritis Who Had Received Limited or No Treatment with Disease-Modifying-Anti-Rheumatic-Drugs (DMARDs):\ + Phase 3 Trial Results. Keywords: Janus kinase (JAK), methotrexate (MTX) and rheumatoid arthritis (RA) and\ + Clinical research. In 2 completed phase 3 studies, baricitinib (bari) improved disease activity with a\ + satisfactory safety profile in patients (pts) with moderately-to-severely active RA who were inadequate\ + responders to either conventional synthetic1 or biologic2DMARDs. This abstract reports results from a\ + phase 3 study of bari administered as monotherapy or in combination with methotrexate (MTX) to pts with\ + early active RA who had limited or no prior treatment with DMARDs. MTX monotherapy was the active comparator." +``` + + +```python +sentences = sent_tokenize(content) +df = spark.createDataFrame(enumerate(sentences), ["index","sentence"]) +``` + + +```python +# Add the tokenizers to all worker nodes +def prepNLTK(partition): + nltk.data.path.append("/dbfs/nltkdata") + return partition + +df = df.rdd.mapPartitions(prepNLTK).toDF() +``` + + +```python +def safe_tokenize(sent): + try: + return word_tokenize(sent) + except LookupError: + prepNLTK(None) + return word_tokenize(sent) + +tokenizeUDF = udf(safe_tokenize, ArrayType(StringType())) +df = df.withColumn("tokens",tokenizeUDF("sentence")) + +countUDF = udf(len, IntegerType()) +df = df.withColumn("count",countUDF("tokens")) + +def wordToEmb(word): + return wordvectors[wordToIndex.get(word.lower(), wordToIndex["UNK"])] + +def featurize(tokens): + X = np.zeros((maxSentenceLen, nFeatures)) + X[-len(tokens):,:] = np.array([wordToEmb(word) for word in tokens]) + return [float(x) for x in X.reshape(maxSentenceLen, nFeatures).flatten()] + +def safe_show(df, retries): + try: + df.show() + except Exception as e: + if retries >= 1: + safe_show(df, retries-1) + else: + raise e + +featurizeUDF = udf(featurize, ArrayType(FloatType())) + +df = df.withColumn("features", featurizeUDF("tokens")).cache() +safe_show(df, 5) # Can be flaky on build server + + +``` + +Run the CNTKModel + + +```python +model = CNTKModel() \ + .setModelLocation(modelSchema.uri) \ + .setInputCol("features") \ + .setOutputCol("probs") \ + .setOutputNodeIndex(0) \ + .setMiniBatchSize(1) + +df = model.transform(df).cache() +df.show() +``` + + +```python +def probsToEntities(probs, wordCount): + reshaped_probs = np.array(probs).reshape(maxSentenceLen, nClasses) + reshaped_probs = reshaped_probs[-wordCount:,:] + return [classToEntity[np.argmax(probs)] for probs in reshaped_probs] + +toEntityUDF = udf(probsToEntities,ArrayType(StringType())) +df = df.withColumn("entities", toEntityUDF("probs", "count")) +df.show() +``` + +Show the annotated text + + +```python +# Color Code the Text based on the entity type +colors = { + "B-Disease": "blue", + "I-Disease":"blue", + "B-Drug":"lime", + "I-Drug":"lime", + "B-Chemical":"lime", + "I-Chemical":"lime", + "O":"black", + "NONE":"black" +} + +def prettyPrint(words, annotations): + formattedWords = [] + for word,annotation in zip(words,annotations): + formattedWord = "{}".format(colors[annotation], word) + if annotation in {"O","NONE"}: + formattedWords.append(formattedWord) + else: + formattedWords.append("{}".format(formattedWord)) + return " ".join(formattedWords) + +prettyPrintUDF = udf(prettyPrint, StringType()) +df = df.withColumn("formattedSentence", prettyPrintUDF("tokens", "entities")) \ + .select("formattedSentence") + +sentences = [row["formattedSentence"] for row in df.collect()] +``` + + +```python +from IPython.core.display import display, HTML +for sentence in sentences: + display(HTML(sentence)) +``` + +Example text used in this demo has been taken from: + +Fleischmann R, Takeuchi T, Schlichting DE, Macias WL, Rooney T, Gurbuz S, Stoykov I, +Beattie SD, Kuo WL, Schiff M. Baricitinib, Methotrexate, or Baricitinib Plus Methotrexate +in Patients with Early Rheumatoid Arthritis Who Had Received Limited or No Treatment with +Disease-Modifying Anti-Rheumatic Drugs (DMARDs): Phase 3 Trial Results [abstract]. +Arthritis Rheumatol. 2015; 67 (suppl 10). +http://acrabstracts.org/abstract/baricitinib-methotrexate-or-baricitinib-plus-methotrexate-in-patients-with-early-rheumatoid-arthritis-who-had-received-limited-or-no-treatment-with-disease-modifying-anti-rheumatic-drugs-dmards-p/. +Accessed August 18, 2017. diff --git a/website/versioned_docs/version-0.9.5/features/other/DeepLearning - CIFAR10 Convolutional Network.md b/website/versioned_docs/version-0.9.5/features/other/DeepLearning - CIFAR10 Convolutional Network.md new file mode 100644 index 0000000000..944bcd482e --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/other/DeepLearning - CIFAR10 Convolutional Network.md @@ -0,0 +1,94 @@ +--- +title: DeepLearning - CIFAR10 Convolutional Network +hide_title: true +status: stable +--- +## DeepLearning - CIFAR10 Convolutional Network + + +```python +from synapse.ml.cntk import CNTKModel +from synapse.ml.downloader import ModelDownloader +from pyspark.sql.functions import udf +from pyspark.sql.types import IntegerType +from os.path import abspath +``` + +Set some paths. + + +```python +cdnURL = "https://mmlspark.azureedge.net/datasets" + +# Please note that this is a copy of the CIFAR10 dataset originally found here: +# http://www.cs.toronto.edu/~kriz/cifar-10-python.tar.gz +imagesWithLabels = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/CIFAR10_test.parquet") +``` + + +```python +modelName = "ConvNet" +modelDir = "dbfs:///models/" +``` + +Get the model + + +```python +d = ModelDownloader(spark, modelDir) +model = d.downloadByName(modelName) + +``` + +Evaluate CNTK model. + + +```python +import time +start = time.time() + +# Use CNTK model to get log probabilities +cntkModel = CNTKModel().setInputCol("images").setOutputCol("output") \ + .setModelLocation(model.uri).setOutputNode("z") +scoredImages = cntkModel.transform(imagesWithLabels) + +# Transform the log probabilities to predictions +def argmax(x): return max(enumerate(x),key=lambda p: p[1])[0] + +argmaxUDF = udf(argmax, IntegerType()) +imagePredictions = scoredImages.withColumn("predictions", argmaxUDF("output")) \ + .select("predictions", "labels") + +numRows = imagePredictions.count() + +end = time.time() +print("classifying {} images took {} seconds".format(numRows,end-start)) +``` + +Plot confusion matrix. + + +```python +imagePredictions = imagePredictions.toPandas() +y, y_hat = imagePredictions["labels"], imagePredictions["predictions"] +``` + + +```python +import matplotlib.pyplot as plt +import numpy as np +from sklearn.metrics import confusion_matrix + +cm = confusion_matrix(y, y_hat) + +labels = ["airplane", "automobile", "bird", "cat", "deer", "dog", "frog", + "horse", "ship", "truck"] +plt.imshow(cm, interpolation="nearest", cmap=plt.cm.Blues) +plt.colorbar() +tick_marks = np.arange(len(labels)) +plt.xticks(tick_marks, labels, rotation=90) +plt.yticks(tick_marks, labels) +plt.xlabel("Predicted label") +plt.ylabel("True Label") +display(plt.show()) +``` diff --git a/website/versioned_docs/version-0.9.5/features/other/DeepLearning - Flower Image Classification.md b/website/versioned_docs/version-0.9.5/features/other/DeepLearning - Flower Image Classification.md new file mode 100644 index 0000000000..dd6da74262 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/other/DeepLearning - Flower Image Classification.md @@ -0,0 +1,139 @@ +--- +title: DeepLearning - Flower Image Classification +hide_title: true +status: stable +--- +## Deep Learning - Flower Image Classification + + +```python +from pyspark.ml import Transformer, Estimator, Pipeline +from pyspark.ml.classification import LogisticRegression +from synapse.ml.downloader import ModelDownloader +import os, sys, time +``` + + +```python +model = ModelDownloader(spark, "dbfs:/models/").downloadByName("ResNet50") +``` + + +```python +# Load the images +# use flowers_and_labels.parquet on larger cluster in order to get better results +imagesWithLabels = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/flowers_and_labels2.parquet") \ + .withColumnRenamed("bytes","image").sample(.1) + +imagesWithLabels.printSchema() +``` + +![Smiley face](https://i.imgur.com/p2KgdYL.jpg) + + +```python +from synapse.ml.opencv import ImageTransformer +from synapse.ml.image import UnrollImage +from synapse.ml.cntk import ImageFeaturizer +from synapse.ml.stages import * + +# Make some featurizers +it = ImageTransformer()\ + .setOutputCol("scaled")\ + .resize(size=(60, 60)) + +ur = UnrollImage()\ + .setInputCol("scaled")\ + .setOutputCol("features") + +dc1 = DropColumns().setCols(["scaled", "image"]) + +lr1 = LogisticRegression().setMaxIter(8).setFeaturesCol("features").setLabelCol("labels") + +dc2 = DropColumns().setCols(["features"]) + +basicModel = Pipeline(stages=[it, ur, dc1, lr1, dc2]) +``` + + +```python +resnet = ImageFeaturizer()\ + .setInputCol("image")\ + .setOutputCol("features")\ + .setModelLocation(model.uri)\ + .setLayerNames(model.layerNames)\ + .setCutOutputLayers(1) + +dc3 = DropColumns().setCols(["image"]) + +lr2 = LogisticRegression().setMaxIter(8).setFeaturesCol("features").setLabelCol("labels") + +dc4 = DropColumns().setCols(["features"]) + +deepModel = Pipeline(stages=[resnet, dc3, lr2, dc4]) +``` + +![Resnet 18](https://i.imgur.com/Mb4Dyou.png) + +### How does it work? + +![Convolutional network weights](http://i.stack.imgur.com/Hl2H6.png) + +### Run the experiment + + +```python +def timedExperiment(model, train, test): + start = time.time() + result = model.fit(train).transform(test).toPandas() + print("Experiment took {}s".format(time.time() - start)) + return result +``` + + +```python +train, test = imagesWithLabels.randomSplit([.8,.2]) +train.count(), test.count() +``` + + +```python +basicResults = timedExperiment(basicModel, train, test) +``` + + +```python +deepResults = timedExperiment(deepModel, train, test) +``` + +### Plot confusion matrix. + + +```python +import matplotlib.pyplot as plt +from sklearn.metrics import confusion_matrix +import numpy as np + +def evaluate(results, name): + y, y_hat = results["labels"],results["prediction"] + y = [int(l) for l in y] + + accuracy = np.mean([1. if pred==true else 0. for (pred,true) in zip(y_hat,y)]) + cm = confusion_matrix(y, y_hat) + cm = cm.astype("float") / cm.sum(axis=1)[:, np.newaxis] + + plt.text(40, 10,"$Accuracy$ $=$ ${}\%$".format(round(accuracy*100,1)),fontsize=14) + plt.imshow(cm, interpolation="nearest", cmap=plt.cm.Blues) + plt.colorbar() + plt.xlabel("$Predicted$ $label$", fontsize=18) + plt.ylabel("$True$ $Label$", fontsize=18) + plt.title("$Normalized$ $CM$ $for$ ${}$".format(name)) + +plt.figure(figsize=(12,5)) +plt.subplot(1,2,1) +evaluate(deepResults,"CNTKModel + LR") +plt.subplot(1,2,2) +evaluate(basicResults,"LR") +# Note that on the larger dataset the accuracy will bump up from 44% to >90% +display(plt.show()) +``` diff --git a/website/versioned_docs/version-0.9.5/features/other/DeepLearning - Transfer Learning.md b/website/versioned_docs/version-0.9.5/features/other/DeepLearning - Transfer Learning.md new file mode 100644 index 0000000000..520237e048 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/other/DeepLearning - Transfer Learning.md @@ -0,0 +1,72 @@ +--- +title: DeepLearning - Transfer Learning +hide_title: true +status: stable +--- +## DeepLearning - Transfer Learning + +Classify automobile vs airplane using DNN featurization and transfer learning +against a subset of images from CIFAR-10 dataset. + +Load DNN Model and pick one of the inner layers as feature output + + +```python +from synapse.ml.cntk import CNTKModel +from synapse.ml.downloader import ModelDownloader +import numpy as np, os, urllib, tarfile, pickle, array +from os.path import abspath +from pyspark.sql.functions import col, udf +from pyspark.sql.types import * +modelName = "ConvNet" +modelDir = "file:" + abspath("models") +d = ModelDownloader(spark, modelDir) +model = d.downloadByName(modelName) +print(model.layerNames) +cntkModel = CNTKModel().setInputCol("images").setOutputCol("features") \ + .setModelLocation(model.uri).setOutputNode("l8") +``` + +Format raw CIFAR data into correct shape. + + +```python +imagesWithLabels = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/CIFAR10_test.parquet") +``` + +Select airplanes (label=0) and automobiles (label=1) + + +```python +imagesWithLabels = imagesWithLabels.filter("labels<2") +imagesWithLabels.cache() +``` + +Featurize images + + +```python +featurizedImages = cntkModel.transform(imagesWithLabels).select(["features","labels"]) +``` + +Use featurized images to train a classifier + + +```python +from synapse.ml.train import TrainClassifier +from pyspark.ml.classification import RandomForestClassifier + +train,test = featurizedImages.randomSplit([0.75,0.25]) + +model = TrainClassifier(model=RandomForestClassifier(),labelCol="labels").fit(train) +``` + +Evaluate the accuracy of the model + + +```python +from synapse.ml.train import ComputeModelStatistics +predictions = model.transform(test) +metrics = ComputeModelStatistics(evaluationMetric="accuracy").transform(predictions) +metrics.show() +``` diff --git a/website/versioned_docs/version-0.9.5/features/other/HyperParameterTuning - Fighting Breast Cancer.md b/website/versioned_docs/version-0.9.5/features/other/HyperParameterTuning - Fighting Breast Cancer.md new file mode 100644 index 0000000000..b730c94158 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/other/HyperParameterTuning - Fighting Breast Cancer.md @@ -0,0 +1,88 @@ +--- +title: HyperParameterTuning - Fighting Breast Cancer +hide_title: true +status: stable +--- +## HyperParameterTuning - Fighting Breast Cancer + +We can do distributed randomized grid search hyperparameter tuning with SynapseML. + +First, we import the packages + + +```python +import pandas as pd + +``` + +Now let's read the data and split it to tuning and test sets: + + +```python +data = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/BreastCancer.parquet").cache() +tune, test = data.randomSplit([0.80, 0.20]) +tune.limit(10).toPandas() +``` + +Next, define the models that wil be tuned: + + +```python +from synapse.ml.automl import TuneHyperparameters +from synapse.ml.train import TrainClassifier +from pyspark.ml.classification import LogisticRegression, RandomForestClassifier, GBTClassifier +logReg = LogisticRegression() +randForest = RandomForestClassifier() +gbt = GBTClassifier() +smlmodels = [logReg, randForest, gbt] +mmlmodels = [TrainClassifier(model=model, labelCol="Label") for model in smlmodels] +``` + +We can specify the hyperparameters using the HyperparamBuilder. +We can add either DiscreteHyperParam or RangeHyperParam hyperparameters. +TuneHyperparameters will randomly choose values from a uniform distribution. + + +```python +from synapse.ml.automl import * + +paramBuilder = \ + HyperparamBuilder() \ + .addHyperparam(logReg, logReg.regParam, RangeHyperParam(0.1, 0.3)) \ + .addHyperparam(randForest, randForest.numTrees, DiscreteHyperParam([5,10])) \ + .addHyperparam(randForest, randForest.maxDepth, DiscreteHyperParam([3,5])) \ + .addHyperparam(gbt, gbt.maxBins, RangeHyperParam(8,16)) \ + .addHyperparam(gbt, gbt.maxDepth, DiscreteHyperParam([3,5])) +searchSpace = paramBuilder.build() +# The search space is a list of params to tuples of estimator and hyperparam +print(searchSpace) +randomSpace = RandomSpace(searchSpace) +``` + +Next, run TuneHyperparameters to get the best model. + + +```python +bestModel = TuneHyperparameters( + evaluationMetric="accuracy", models=mmlmodels, numFolds=2, + numRuns=len(mmlmodels) * 2, parallelism=1, + paramSpace=randomSpace.space(), seed=0).fit(tune) +``` + +We can view the best model's parameters and retrieve the underlying best model pipeline + + +```python +print(bestModel.getBestModelInfo()) +print(bestModel.getBestModel()) +``` + +We can score against the test set and view metrics. + + +```python +from synapse.ml.train import ComputeModelStatistics +prediction = bestModel.transform(test) +metrics = ComputeModelStatistics().transform(prediction) +metrics.limit(10).toPandas() +``` diff --git a/website/versioned_docs/version-0.9.5/features/other/TextAnalytics - Amazon Book Reviews with Word2Vec.md b/website/versioned_docs/version-0.9.5/features/other/TextAnalytics - Amazon Book Reviews with Word2Vec.md new file mode 100644 index 0000000000..59fcf6a1fe --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/other/TextAnalytics - Amazon Book Reviews with Word2Vec.md @@ -0,0 +1,122 @@ +--- +title: TextAnalytics - Amazon Book Reviews with Word2Vec +hide_title: true +status: stable +--- +## TextAnalytics - Amazon Book Reviews with Word2Vec + +Yet again, now using the `Word2Vec` Estimator from Spark. We can use the tree-based +learners from spark in this scenario due to the lower dimensionality representation of +features. + + +```python +import os +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() +``` + + +```python +import pandas as pd + +``` + + +```python +data = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/BookReviewsFromAmazon10K.parquet") +data.limit(10).toPandas() +``` + +Modify the label column to predict a rating greater than 3. + + +```python +processedData = data.withColumn("label", data["rating"] > 3) \ + .select(["text", "label"]) +processedData.limit(5).toPandas() +``` + +Split the dataset into train, test and validation sets. + + +```python +train, test, validation = processedData.randomSplit([0.60, 0.20, 0.20]) +``` + +Use `Tokenizer` and `Word2Vec` to generate the features. + + +```python +from pyspark.ml import Pipeline +from pyspark.ml.feature import Tokenizer, Word2Vec +tokenizer = Tokenizer(inputCol="text", outputCol="words") +partitions = train.rdd.getNumPartitions() +word2vec = Word2Vec(maxIter=4, seed=42, inputCol="words", outputCol="features", + numPartitions=partitions) +textFeaturizer = Pipeline(stages = [tokenizer, word2vec]).fit(train) +``` + +Transform each of the train, test and validation datasets. + + +```python +ptrain = textFeaturizer.transform(train).select(["label", "features"]) +ptest = textFeaturizer.transform(test).select(["label", "features"]) +pvalidation = textFeaturizer.transform(validation).select(["label", "features"]) +ptrain.limit(5).toPandas() +``` + +Generate several models with different parameters from the training data. + + +```python +from pyspark.ml.classification import LogisticRegression, RandomForestClassifier, GBTClassifier +from synapse.ml.train import TrainClassifier +import itertools + +lrHyperParams = [0.05, 0.2] +logisticRegressions = [LogisticRegression(regParam = hyperParam) + for hyperParam in lrHyperParams] +lrmodels = [TrainClassifier(model=lrm, labelCol="label").fit(ptrain) + for lrm in logisticRegressions] + +rfHyperParams = itertools.product([5, 10], [2, 3]) +randomForests = [RandomForestClassifier(numTrees=hyperParam[0], maxDepth=hyperParam[1]) + for hyperParam in rfHyperParams] +rfmodels = [TrainClassifier(model=rfm, labelCol="label").fit(ptrain) + for rfm in randomForests] + +gbtHyperParams = itertools.product([8, 16], [2, 3]) +gbtclassifiers = [GBTClassifier(maxBins=hyperParam[0], maxDepth=hyperParam[1]) + for hyperParam in gbtHyperParams] +gbtmodels = [TrainClassifier(model=gbt, labelCol="label").fit(ptrain) + for gbt in gbtclassifiers] + +trainedModels = lrmodels + rfmodels + gbtmodels +``` + +Find the best model for the given test dataset. + + +```python +from synapse.ml.automl import FindBestModel +bestModel = FindBestModel(evaluationMetric="AUC", models=trainedModels).fit(ptest) +bestModel.getRocCurve().show() +bestModel.getBestModelMetrics().show() +bestModel.getAllModelMetrics().show() +``` + +Get the accuracy from the validation dataset. + + +```python +from synapse.ml.train import ComputeModelStatistics +predictions = bestModel.transform(pvalidation) +metrics = ComputeModelStatistics().transform(predictions) +print("Best model's accuracy on validation set = " + + "{0:.2f}%".format(metrics.first()["accuracy"] * 100)) +print("Best model's AUC on validation set = " + + "{0:.2f}%".format(metrics.first()["AUC"] * 100)) +``` diff --git a/website/versioned_docs/version-0.9.5/features/other/TextAnalytics - Amazon Book Reviews.md b/website/versioned_docs/version-0.9.5/features/other/TextAnalytics - Amazon Book Reviews.md new file mode 100644 index 0000000000..e0443d6044 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/other/TextAnalytics - Amazon Book Reviews.md @@ -0,0 +1,93 @@ +--- +title: TextAnalytics - Amazon Book Reviews +hide_title: true +status: stable +--- +## TextAnalytics - Amazon Book Reviews + +Again, try to predict Amazon book ratings greater than 3 out of 5, this time using +the `TextFeaturizer` module which is a composition of several text analytics APIs that +are native to Spark. + + +```python +import os +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() +``` + + +```python +import pandas as pd +``` + + +```python +data = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/BookReviewsFromAmazon10K.parquet") +data.limit(10).toPandas() +``` + +Use `TextFeaturizer` to generate our features column. We remove stop words, and use TF-IDF +to generate 2²⁰ sparse features. + + +```python +from synapse.ml.featurize.text import TextFeaturizer +textFeaturizer = TextFeaturizer() \ + .setInputCol("text").setOutputCol("features") \ + .setUseStopWordsRemover(True).setUseIDF(True).setMinDocFreq(5).setNumFeatures(1 << 16).fit(data) +``` + + +```python +processedData = textFeaturizer.transform(data) +processedData.limit(5).toPandas() +``` + +Change the label so that we can predict whether the rating is greater than 3 using a binary +classifier. + + +```python +processedData = processedData.withColumn("label", processedData["rating"] > 3) \ + .select(["features", "label"]) +processedData.limit(5).toPandas() +``` + +Train several Logistic Regression models with different regularizations. + + +```python +train, test, validation = processedData.randomSplit([0.60, 0.20, 0.20]) +from pyspark.ml.classification import LogisticRegression + +lrHyperParams = [0.05, 0.1, 0.2, 0.4] +logisticRegressions = [LogisticRegression(regParam = hyperParam) for hyperParam in lrHyperParams] + +from synapse.ml.train import TrainClassifier +lrmodels = [TrainClassifier(model=lrm, labelCol="label").fit(train) for lrm in logisticRegressions] +``` + +Find the model with the best AUC on the test set. + + +```python +from synapse.ml.automl import FindBestModel, BestModel +bestModel = FindBestModel(evaluationMetric="AUC", models=lrmodels).fit(test) +bestModel.getRocCurve().show() +bestModel.getBestModelMetrics().show() +bestModel.getAllModelMetrics().show() + +``` + +Use the optimized `ComputeModelStatistics` API to find the model accuracy. + + +```python +from synapse.ml.train import ComputeModelStatistics +predictions = bestModel.transform(validation) +metrics = ComputeModelStatistics().transform(predictions) +print("Best model's accuracy on validation set = " + + "{0:.2f}%".format(metrics.first()["accuracy"] * 100)) +``` diff --git a/website/versioned_docs/version-0.9.5/features/regression/Regression - Auto Imports.md b/website/versioned_docs/version-0.9.5/features/regression/Regression - Auto Imports.md new file mode 100644 index 0000000000..fa3a43694e --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/regression/Regression - Auto Imports.md @@ -0,0 +1,214 @@ +--- +title: Regression - Auto Imports +hide_title: true +status: stable +--- +## Regression - Auto Imports + +This sample notebook is based on the Gallery [Sample 6: Train, Test, Evaluate +for Regression: Auto Imports +Dataset](https://gallery.cortanaintelligence.com/Experiment/670fbfc40c4f44438bfe72e47432ae7a) +for AzureML Studio. This experiment demonstrates how to build a regression +model to predict the automobile's price. The process includes training, testing, +and evaluating the model on the Automobile Imports data set. + +This sample demonstrates the use of several members of the synapseml library: +- [`TrainRegressor` + ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.train.html?#module-synapse.ml.train.TrainRegressor) +- [`SummarizeData` + ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.stages.html?#module-synapse.ml.stages.SummarizeData) +- [`CleanMissingData` + ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.featurize.html?#module-synapse.ml.featurize.CleanMissingData) +- [`ComputeModelStatistics` + ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.train.html?#module-synapse.ml.train.ComputeModelStatistics) +- [`FindBestModel` + ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.automl.html?#module-synapse.ml.automl.FindBestModel) + +First, import the pandas package so that we can read and parse the datafile +using `pandas.read_csv()` + + +```python +import os +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() +``` + + +```python +data = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/AutomobilePriceRaw.parquet") + +``` + +To learn more about the data that was just read into the DataFrame, +summarize the data using `SummarizeData` and print the summary. For each +column of the DataFrame, `SummarizeData` will report the summary statistics +in the following subcategories for each column: +* Feature name +* Counts + - Count + - Unique Value Count + - Missing Value Count +* Quantiles + - Min + - 1st Quartile + - Median + - 3rd Quartile + - Max +* Sample Statistics + - Sample Variance + - Sample Standard Deviation + - Sample Skewness + - Sample Kurtosis +* Percentiles + - P0.5 + - P1 + - P5 + - P95 + - P99 + - P99.5 + +Note that several columns have missing values (`normalized-losses`, `bore`, +`stroke`, `horsepower`, `peak-rpm`, `price`). This summary can be very +useful during the initial phases of data discovery and characterization. + + +```python +from synapse.ml.stages import SummarizeData +summary = SummarizeData().transform(data) +summary.toPandas() +``` + +Split the dataset into train and test datasets. + + +```python +# split the data into training and testing datasets +train, test = data.randomSplit([0.6, 0.4], seed=123) +train.limit(10).toPandas() +``` + +Now use the `CleanMissingData` API to replace the missing values in the +dataset with something more useful or meaningful. Specify a list of columns +to be cleaned, and specify the corresponding output column names, which are +not required to be the same as the input column names. `CleanMissiongData` +offers the options of "Mean", "Median", or "Custom" for the replacement +value. In the case of "Custom" value, the user also specifies the value to +use via the "customValue" parameter. In this example, we will replace +missing values in numeric columns with the median value for the column. We +will define the model here, then use it as a Pipeline stage when we train our +regression models and make our predictions in the following steps. + + +```python +from synapse.ml.featurize import CleanMissingData +cols = ["normalized-losses", "stroke", "bore", "horsepower", + "peak-rpm", "price"] +cleanModel = CleanMissingData().setCleaningMode("Median") \ + .setInputCols(cols).setOutputCols(cols) +``` + +Now we will create two Regressor models for comparison: Poisson Regression +and Random Forest. PySpark has several regressors implemented: +* `LinearRegression` +* `IsotonicRegression` +* `DecisionTreeRegressor` +* `RandomForestRegressor` +* `GBTRegressor` (Gradient-Boosted Trees) +* `AFTSurvivalRegression` (Accelerated Failure Time Model Survival) +* `GeneralizedLinearRegression` -- fit a generalized model by giving symbolic + description of the linear preditor (link function) and a description of the + error distribution (family). The following families are supported: + - `Gaussian` + - `Binomial` + - `Poisson` + - `Gamma` + - `Tweedie` -- power link function specified through `linkPower` +Refer to the +[Pyspark API Documentation](http://spark.apache.org/docs/latest/api/python/) +for more details. + +`TrainRegressor` creates a model based on the regressor and other parameters +that are supplied to it, then trains data on the model. + +In this next step, Create a Poisson Regression model using the +`GeneralizedLinearRegressor` API from Spark and create a Pipeline using the +`CleanMissingData` and `TrainRegressor` as pipeline stages to create and +train the model. Note that because `TrainRegressor` expects a `labelCol` to +be set, there is no need to set `linkPredictionCol` when setting up the +`GeneralizedLinearRegressor`. Fitting the pipe on the training dataset will +train the model. Applying the `transform()` of the pipe to the test dataset +creates the predictions. + + +```python +# train Poisson Regression Model +from pyspark.ml.regression import GeneralizedLinearRegression +from pyspark.ml import Pipeline +from synapse.ml.train import TrainRegressor + +glr = GeneralizedLinearRegression(family="poisson", link="log") +poissonModel = TrainRegressor().setModel(glr).setLabelCol("price").setNumFeatures(256) +poissonPipe = Pipeline(stages = [cleanModel, poissonModel]).fit(train) +poissonPrediction = poissonPipe.transform(test) +``` + +Next, repeat these steps to create a Random Forest Regression model using the +`RandomRorestRegressor` API from Spark. + + +```python +# train Random Forest regression on the same training data: +from pyspark.ml.regression import RandomForestRegressor + +rfr = RandomForestRegressor(maxDepth=30, maxBins=128, numTrees=8, minInstancesPerNode=1) +randomForestModel = TrainRegressor(model=rfr, labelCol="price", numFeatures=256).fit(train) +randomForestPipe = Pipeline(stages = [cleanModel, randomForestModel]).fit(train) +randomForestPrediction = randomForestPipe.transform(test) +``` + +After the models have been trained and scored, compute some basic statistics +to evaluate the predictions. The following statistics are calculated for +regression models to evaluate: +* Mean squared error +* Root mean squared error +* R^2 +* Mean absolute error + +Use the `ComputeModelStatistics` API to compute basic statistics for +the Poisson and the Random Forest models. + + +```python +from synapse.ml.train import ComputeModelStatistics +poissonMetrics = ComputeModelStatistics().transform(poissonPrediction) +print("Poisson Metrics") +poissonMetrics.toPandas() +``` + + +```python +randomForestMetrics = ComputeModelStatistics().transform(randomForestPrediction) +print("Random Forest Metrics") +randomForestMetrics.toPandas() +``` + +We can also compute per instance statistics for `poissonPrediction`: + + +```python +from synapse.ml.train import ComputePerInstanceStatistics +def demonstrateEvalPerInstance(pred): + return ComputePerInstanceStatistics().transform(pred) \ + .select("price", "prediction", "L1_loss", "L2_loss") \ + .limit(10).toPandas() +demonstrateEvalPerInstance(poissonPrediction) +``` + +and with `randomForestPrediction`: + + +```python +demonstrateEvalPerInstance(randomForestPrediction) +``` diff --git a/website/versioned_docs/version-0.9.5/features/regression/Regression - Flight Delays with DataCleaning.md b/website/versioned_docs/version-0.9.5/features/regression/Regression - Flight Delays with DataCleaning.md new file mode 100644 index 0000000000..cb31243867 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/regression/Regression - Flight Delays with DataCleaning.md @@ -0,0 +1,153 @@ +--- +title: Regression - Flight Delays with DataCleaning +hide_title: true +status: stable +--- +## Regression - Flight Delays with DataCleaning + +This example notebook is similar to +[Regression - Flight Delays](https://github.com/microsoft/SynapseML/blob/master/notebooks/Regression%20-%20Flight%20Delays.ipynb). +In this example, we will demonstrate the use of `DataConversion()` in two +ways. First, to convert the data type of several columns after the dataset +has been read in to the Spark DataFrame instead of specifying the data types +as the file is read in. Second, to convert columns to categorical columns +instead of iterating over the columns and applying the `StringIndexer`. + +This sample demonstrates how to use the following APIs: +- [`TrainRegressor` + ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.train.html?#module-synapse.ml.train.TrainRegressor) +- [`ComputePerInstanceStatistics` + ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.train.html?#module-synapse.ml.train.ComputePerInstanceStatistics) +- [`DataConversion` + ](https://mmlspark.blob.core.windows.net/docs/0.9.5/pyspark/synapse.ml.featurize.html?#module-synapse.ml.featurize.DataConversion) + +First, import the pandas package + + +```python +import os +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() +``` + + +```python +import pandas as pd +``` + +Next, import the CSV dataset: retrieve the file if needed, save it locally, +read the data into a pandas dataframe via `read_csv()`, then convert it to +a Spark dataframe. + +Print the schema of the dataframe, and note the columns that are `long`. + + +```python +flightDelay = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/On_Time_Performance_2012_9.parquet") +# print some basic info +print("records read: " + str(flightDelay.count())) +print("Schema: ") +flightDelay.printSchema() +flightDelay.limit(10).toPandas() +``` + +Use the `DataConversion` transform API to convert the columns listed to +double. + +The `DataConversion` API accepts the following types for the `convertTo` +parameter: +* `boolean` +* `byte` +* `short` +* `integer` +* `long` +* `float` +* `double` +* `string` +* `toCategorical` +* `clearCategorical` +* `date` -- converts a string or long to a date of the format + "yyyy-MM-dd HH:mm:ss" unless another format is specified by +the `dateTimeFormat` parameter. + +Again, print the schema and note that the columns are now `double` +instead of long. + + +```python +from synapse.ml.featurize import DataConversion +flightDelay = DataConversion(cols=["Quarter","Month","DayofMonth","DayOfWeek", + "OriginAirportID","DestAirportID", + "CRSDepTime","CRSArrTime"], + convertTo="double") \ + .transform(flightDelay) +flightDelay.printSchema() +flightDelay.limit(10).toPandas() +``` + +Split the datasest into train and test sets. + + +```python +train, test = flightDelay.randomSplit([0.75, 0.25]) +``` + +Create a regressor model and train it on the dataset. + +First, use `DataConversion` to convert the columns `Carrier`, `DepTimeBlk`, +and `ArrTimeBlk` to categorical data. Recall that in Notebook 102, this +was accomplished by iterating over the columns and converting the strings +to index values using the `StringIndexer` API. The `DataConversion` API +simplifies the task by allowing you to specify all columns that will have +the same end type in a single command. + +Create a LinearRegression model using the Limited-memory BFGS solver +(`l-bfgs`), an `ElasticNet` mixing parameter of `0.3`, and a `Regularization` +of `0.1`. + +Train the model with the `TrainRegressor` API fit on the training dataset. + + +```python +from synapse.ml.train import TrainRegressor, TrainedRegressorModel +from pyspark.ml.regression import LinearRegression + +trainCat = DataConversion(cols=["Carrier","DepTimeBlk","ArrTimeBlk"], + convertTo="toCategorical") \ + .transform(train) +testCat = DataConversion(cols=["Carrier","DepTimeBlk","ArrTimeBlk"], + convertTo="toCategorical") \ + .transform(test) +lr = LinearRegression().setRegParam(0.1) \ + .setElasticNetParam(0.3) +model = TrainRegressor(model=lr, labelCol="ArrDelay").fit(trainCat) +``` + +Score the regressor on the test data. + + +```python +scoredData = model.transform(testCat) +scoredData.limit(10).toPandas() +``` + +Compute model metrics against the entire scored dataset + + +```python +from synapse.ml.train import ComputeModelStatistics +metrics = ComputeModelStatistics().transform(scoredData) +metrics.toPandas() +``` + +Finally, compute and show statistics on individual predictions in the test +dataset, demonstrating the usage of `ComputePerInstanceStatistics` + + +```python +from synapse.ml.train import ComputePerInstanceStatistics +evalPerInstance = ComputePerInstanceStatistics().transform(scoredData) +evalPerInstance.select("ArrDelay", "prediction", "L1_loss", "L2_loss") \ + .limit(10).toPandas() +``` diff --git a/website/versioned_docs/version-0.9.5/features/regression/Regression - Flight Delays.md b/website/versioned_docs/version-0.9.5/features/regression/Regression - Flight Delays.md new file mode 100644 index 0000000000..d5102ab604 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/regression/Regression - Flight Delays.md @@ -0,0 +1,100 @@ +--- +title: Regression - Flight Delays +hide_title: true +status: stable +--- +## Regression - Flight Delays + +In this example, we run a linear regression on the *Flight Delay* dataset to predict the delay times. + +We demonstrate how to use the `TrainRegressor` and the `ComputePerInstanceStatistics` APIs. + +First, import the packages. + + +```python +import os +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() +``` + + +```python +import numpy as np +import pandas as pd +import synapse.ml +``` + +Next, import the CSV dataset. + + +```python +flightDelay = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/On_Time_Performance_2012_9.parquet") +# print some basic info +print("records read: " + str(flightDelay.count())) +print("Schema: ") +flightDelay.printSchema() +flightDelay.limit(10).toPandas() +``` + +Split the dataset into train and test sets. + + +```python +train,test = flightDelay.randomSplit([0.75, 0.25]) +``` + +Train a regressor on dataset with `l-bfgs`. + + +```python +from synapse.ml.train import TrainRegressor, TrainedRegressorModel +from pyspark.ml.regression import LinearRegression +from pyspark.ml.feature import StringIndexer +# Convert columns to categorical +catCols = ["Carrier", "DepTimeBlk", "ArrTimeBlk"] +trainCat = train +testCat = test +for catCol in catCols: + simodel = StringIndexer(inputCol=catCol, outputCol=catCol + "Tmp").fit(train) + trainCat = simodel.transform(trainCat).drop(catCol).withColumnRenamed(catCol + "Tmp", catCol) + testCat = simodel.transform(testCat).drop(catCol).withColumnRenamed(catCol + "Tmp", catCol) +lr = LinearRegression().setRegParam(0.1).setElasticNetParam(0.3) +model = TrainRegressor(model=lr, labelCol="ArrDelay").fit(trainCat) +``` + +Save, load, or Score the regressor on the test data. + + +```python +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + model_name = "/models/flightDelayModel.mml" +else: + model_name = "dbfs:/flightDelayModel.mml" + +model.write().overwrite().save(model_name) +flightDelayModel = TrainedRegressorModel.load(model_name) + +scoredData = flightDelayModel.transform(testCat) +scoredData.limit(10).toPandas() +``` + +Compute model metrics against the entire scored dataset + + +```python +from synapse.ml.train import ComputeModelStatistics +metrics = ComputeModelStatistics().transform(scoredData) +metrics.toPandas() +``` + +Finally, compute and show per-instance statistics, demonstrating the usage +of `ComputePerInstanceStatistics`. + + +```python +from synapse.ml.train import ComputePerInstanceStatistics +evalPerInstance = ComputePerInstanceStatistics().transform(scoredData) +evalPerInstance.select("ArrDelay", "prediction", "L1_loss", "L2_loss").limit(10).toPandas() +``` diff --git a/website/versioned_docs/version-0.9.5/features/regression/Regression - Vowpal Wabbit vs. LightGBM vs. Linear Regressor.md b/website/versioned_docs/version-0.9.5/features/regression/Regression - Vowpal Wabbit vs. LightGBM vs. Linear Regressor.md new file mode 100644 index 0000000000..c2df5768ba --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/regression/Regression - Vowpal Wabbit vs. LightGBM vs. Linear Regressor.md @@ -0,0 +1,258 @@ +--- +title: Regression - Vowpal Wabbit vs. LightGBM vs. Linear Regressor +hide_title: true +status: stable +--- +# Vowpal Wabbit and LightGBM for a Regression Problem + +This notebook shows how to build simple regression models by using +[Vowpal Wabbit (VW)](https://github.com/VowpalWabbit/vowpal_wabbit) and +[LightGBM](https://github.com/microsoft/LightGBM) with SynapseML. + We also compare the results with + [Spark MLlib Linear Regression](https://spark.apache.org/docs/latest/ml-classification-regression.html#linear-regression). + + +```python +import os +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() +``` + + +```python +import math +from synapse.ml.train import ComputeModelStatistics +from synapse.ml.vw import VowpalWabbitRegressor, VowpalWabbitFeaturizer +from synapse.ml.lightgbm import LightGBMRegressor +import numpy as np +import pandas as pd +from pyspark.ml.feature import VectorAssembler +from pyspark.ml.regression import LinearRegression +from sklearn.datasets import load_boston +``` + +## Prepare Dataset +We use [*Boston house price* dataset](https://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_boston.html) +. +The data was collected in 1978 from Boston area and consists of 506 entries with 14 features including the value of homes. +We use `sklearn.datasets` module to download it easily, then split the set into training and testing by 75/25. + + +```python +boston = load_boston() + +feature_cols = ['f' + str(i) for i in range(boston.data.shape[1])] +header = ['target'] + feature_cols +df = spark.createDataFrame(pd.DataFrame(data=np.column_stack((boston.target, boston.data)), columns=header)).repartition(1) +print("Dataframe has {} rows".format(df.count())) +display(df.limit(10).toPandas()) +``` + + +```python +train_data, test_data = df.randomSplit([0.75, 0.25], seed=42) +``` + +Following is the summary of the training set. + + +```python +display(train_data.summary().toPandas()) +``` + +Plot feature distributions over different target values (house prices in our case). + + +```python +features = train_data.columns[1:] +values = train_data.drop('target').toPandas() +ncols = 5 +nrows = math.ceil(len(features) / ncols) +``` + +## Baseline - Spark MLlib Linear Regressor + +First, we set a baseline performance by using Linear Regressor in Spark MLlib. + + +```python +featurizer = VectorAssembler(inputCols=feature_cols, outputCol='features') +lr_train_data = featurizer.transform(train_data)['target', 'features'] +lr_test_data = featurizer.transform(test_data)['target', 'features'] +display(lr_train_data.limit(10).toPandas()) +``` + + +```python +# By default, `maxIter` is 100. Other params you may want to change include: `regParam`, `elasticNetParam`, etc. +lr = LinearRegression(labelCol='target') + +lr_model = lr.fit(lr_train_data) +lr_predictions = lr_model.transform(lr_test_data) + +display(lr_predictions.limit(10).toPandas()) +``` + +We evaluate the prediction result by using `synapse.ml.train.ComputeModelStatistics` which returns four metrics: +* [MSE (Mean Squared Error)](https://en.wikipedia.org/wiki/Mean_squared_error) +* [RMSE (Root Mean Squared Error)](https://en.wikipedia.org/wiki/Root-mean-square_deviation) = sqrt(MSE) +* [R quared](https://en.wikipedia.org/wiki/Coefficient_of_determination) +* [MAE (Mean Absolute Error)](https://en.wikipedia.org/wiki/Mean_absolute_error) + + +```python +metrics = ComputeModelStatistics( + evaluationMetric='regression', + labelCol='target', + scoresCol='prediction').transform(lr_predictions) + +results = metrics.toPandas() +results.insert(0, 'model', ['Spark MLlib - Linear Regression']) +display(results) +``` + +## Vowpal Wabbit + +Perform VW-style feature hashing. Many types (numbers, string, bool, map of string to (number, string)) are supported. + + +```python +vw_featurizer = VowpalWabbitFeaturizer( + inputCols=feature_cols, + outputCol='features') + +vw_train_data = vw_featurizer.transform(train_data)['target', 'features'] +vw_test_data = vw_featurizer.transform(test_data)['target', 'features'] +display(vw_train_data.limit(10).toPandas()) +``` + +See [VW wiki](https://github.com/vowpalWabbit/vowpal_wabbit/wiki/Command-Line-Arguments) for command line arguments. + + +```python +# Use the same number of iterations as Spark MLlib's Linear Regression (=100) +args = "--holdout_off --loss_function quantile -l 7 -q :: --power_t 0.3" +vwr = VowpalWabbitRegressor( + labelCol='target', + args=args, + numPasses=100) + +# To reduce number of partitions (which will effect performance), use `vw_train_data.repartition(1)` +vw_train_data_2 = vw_train_data.repartition(1).cache() +print(vw_train_data_2.count()) +vw_model = vwr.fit(vw_train_data_2.repartition(1)) +vw_predictions = vw_model.transform(vw_test_data) + +display(vw_predictions.limit(10).toPandas()) +``` + + +```python +metrics = ComputeModelStatistics( + evaluationMetric='regression', + labelCol='target', + scoresCol='prediction').transform(vw_predictions) + +vw_result = metrics.toPandas() +vw_result.insert(0, 'model', ['Vowpal Wabbit']) +results = results.append( + vw_result, + ignore_index=True) + +display(results) +``` + +## LightGBM + + +```python +lgr = LightGBMRegressor( + objective='quantile', + alpha=0.2, + learningRate=0.3, + numLeaves=31, + labelCol='target', + numIterations=100) + +# Using one partition since the training dataset is very small +repartitioned_data = lr_train_data.repartition(1).cache() +print(repartitioned_data.count()) +lg_model = lgr.fit(repartitioned_data) +lg_predictions = lg_model.transform(lr_test_data) + +display(lg_predictions.limit(10).toPandas()) +``` + + +```python +metrics = ComputeModelStatistics( + evaluationMetric='regression', + labelCol='target', + scoresCol='prediction').transform(lg_predictions) + +lg_result = metrics.toPandas() +lg_result.insert(0, 'model', ['LightGBM']) + +results = results.append( + lg_result, + ignore_index=True) + +display(results) +``` + +Following figure shows the actual-vs.-prediction graphs of the results: + +lr-vw-lg + + +```python +if os.environ.get("AZURE_SERVICE", None) != "Microsoft.ProjectArcadia": + from matplotlib.colors import ListedColormap, Normalize + from matplotlib.cm import get_cmap + import matplotlib.pyplot as plt + + f, axes = plt.subplots(nrows, ncols, sharey=True, figsize=(30,10)) + f.tight_layout() + yy = [r['target'] for r in train_data.select('target').collect()] + for irow in range(nrows): + axes[irow][0].set_ylabel('target') + for icol in range(ncols): + try: + feat = features[irow*ncols + icol] + xx = values[feat] + axes[irow][icol].scatter(xx, yy, s=10, alpha=0.25) + axes[irow][icol].set_xlabel(feat) + axes[irow][icol].get_yaxis().set_ticks([]) + except IndexError: + f.delaxes(axes[irow][icol]) + + cmap = get_cmap('YlOrRd') + + target = np.array(test_data.select('target').collect()).flatten() + model_preds = [ + ("Spark MLlib Linear Regression", lr_predictions), + ("Vowpal Wabbit", vw_predictions), + ("LightGBM", lg_predictions)] + + f, axes = plt.subplots(1, len(model_preds), sharey=True, figsize=(18, 6)) + f.tight_layout() + + for i, (model_name, preds) in enumerate(model_preds): + preds = np.array(preds.select('prediction').collect()).flatten() + err = np.absolute(preds - target) + + norm = Normalize() + clrs = cmap(np.asarray(norm(err)))[:, :-1] + axes[i].scatter(preds, target, s=60, c=clrs, edgecolors='#888888', alpha=0.75) + axes[i].plot((0, 60), (0, 60), linestyle='--', color='#888888') + axes[i].set_xlabel('Predicted values') + if i ==0: + axes[i].set_ylabel('Actual values') + axes[i].set_title(model_name) +``` + + +```python + +``` diff --git a/website/versioned_docs/version-0.9.5/features/responsible_ai/Data Balance Analysis.md b/website/versioned_docs/version-0.9.5/features/responsible_ai/Data Balance Analysis.md new file mode 100644 index 0000000000..52d60c9c21 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/responsible_ai/Data Balance Analysis.md @@ -0,0 +1,200 @@ +--- +title: Data Balance Analysis on Spark +hide_title: true +sidebar_label: Data Balance Analysis +description: Learn how to do Data Balance Analysis on Spark to determine how well features and feature values are represented in your dataset. +--- + +# Data Balance Analysis on Spark + +## Context + +Data Balance Analysis is relevant for overall understanding of datasets, but it becomes essential when thinking about building Machine Learning services out of such datasets. Having a well balanced data representation is critical when developing models in a responsible way, specially in terms of fairness. +It is unfortunately all too easy to build an ML model that produces biased results for subsets of an overall population, by training or testing the model on biased ground truth data. There are multiple case studies of biased models assisting in granting loans, healthcare, recruitment opportunities and many other decision making tasks. In most of these examples, the data from which these models are trained was the common issue. These findings emphasize how important it is for model creators and auditors to analyze data balance: to measure training data across sub-populations and ensure the data has good coverage and a balanced representation of labels across sensitive categories and category combinations, and to check that test data is representative of the target population. + +In summary, Data Balance Analysis, used as a step for building ML models has the following benefits: + +* **Reduces risks for unbalanced models (facilitate service fairness) and reduces costs of ML building** by identifying early on data representation gaps that prompt data scientists to seek mitigation steps (collect more data, follow a specific sampling mechanism, create synthetic data, etc.) before proceeding to train their models. +* **Enables easy e2e debugging of ML systems** in combination with [Fairlearn](https://fairlearn.org/) by providing a clear view if for an unbalanced model the issue is tied to the data or the model. + +## Examples + +* [Data Balance Analysis - Adult Census Income](../../../features/responsible_ai/DataBalanceAnalysis%20-%20Adult%20Census%20Income) + +## Usage + +Data Balance Analysis currently supports three transformers in the `synapse.ml.exploratory` namespace: + +* FeatureBalanceMeasure - supervised (requires label column) +* DistributionBalanceMeasure - unsupervised (doesn't require label column) +* AggregateBalanceMeasure - unsupervised (doesn't require label column) + +1. Import all three transformers. + + For example: + + ```python + from synapse.ml.exploratory import AggregateBalanceMeasure, DistributionBalanceMeasure, FeatureBalanceMeasure + ``` + +2. Load your dataset, define features of interest, and ensure that the label column is binary. The `FeatureBalanceMeasure` transformer currently only supports binary labels, but support for numerical labels will be added soon. + + For example: + + ```python + import pyspark.sql.functions as F + + features = ["race", "sex"] + label = "income" + + df = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/AdultCensusIncome.parquet") + + # Convert the "income" column from {<=50K, >50K} to {0, 1} to represent our binary classification label column + df = df.withColumn(label, F.when(F.col(label).contains("<=50K"), F.lit(0)).otherwise(F.lit(1))) + ``` + +3. Create a `FeatureBalanceMeasure` transformer and call `setSensitiveCols` to set the list of sensitive features and call `setLabelCol` to set the binary label column. Then, call the `transform` method with your dataset and visualize the resulting dataframe. + + For example: + + ```python + feature_balance_measures = ( + FeatureBalanceMeasure() + .setSensitiveCols(features) + .setLabelCol(label) + .transform(df) + ) + feature_balance_measures.show(truncate=False) + ``` + +4. Create a `DistributionBalanceMeasure` transformer and and call `setSensitiveCols` to set the list of sensitive features. Then, call the `transform` method with your dataset and visualize the resulting dataframe. + + For example: + + ```python + distribution_balance_measures = ( + DistributionBalanceMeasure() + .setSensitiveCols(features) + .transform(df) + ) + distribution_balance_measures.show(truncate=False) + ``` + +5. Create a `AggregateBalanceMeasure` transformer and and call `setSensitiveCols` to set the list of sensitive features. Then, call the `transform` method with your dataset and visualize the resulting dataframe. + + For example: + + ```python + aggregate_balance_measures = ( + AggregateBalanceMeasure() + .setSensitiveCols(features) + .transform(df) + ) + aggregate_balance_measures.show(truncate=False) + ``` + +Note: If you are running this notebook in a Spark environment such as Azure Synapse or Databricks, then you can easily visualize the imbalance measures by calling the built-in plotting features `display()`. + +## Measure Explanations + +### Feature Balance Measures + +Feature Balance Measures allow us to see whether each combination of sensitive feature is receiving the positive outcome (true prediction) at balanced probability. + +In this context, we define a feature balance measure, also referred to as the parity, for label y as the difference between the association metrics of two different sensitive classes $[x_A, x_B]$, with respect to the association metric $A(x_i, y)$. That is: + +$parity(y \vert x_A, x_B, A(\cdot)) \coloneqq A(x_A, y) - A(x_B, y)$ + +Using the dataset, we can see if the various sexes and races are receiving >50k income at equal or unequal rates. + +Note: Many of these metrics were influenced by this paper [Measuring Model Biases in the Absence of Ground Truth](https://arxiv.org/abs/2103.03417). + +| Association Metric | Family | Description | Interpretation/Formula | Reference | +|----------------------------------------------------|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------| +| Demographic Parity | Fairness | Proportion of each segment of a protected class (e.g. gender) should receive the positive outcome at equal rates. | As close to 0 means better parity. $DP = P(Y \vert A = "Male") - P(Y \vert A = "Female")$. | [Link](https://en.wikipedia.org/wiki/Fairness_%28machine_learning%29) | +| Pointwise Mutual Information (PMI), normalized PMI | Entropy | The PMI of a pair of feature values (ex: Gender=Male and Gender=Female) quantifies the discrepancy between the probability of their coincidence given their joint distribution and their individual distributions (assuming independence). | Range (normalized) $[-1, 1]$. -1 for no co-occurences. 0 for co-occurences at random. 1 for complete co-occurences. | [Link](https://en.wikipedia.org/wiki/Pointwise_mutual_information) | +| Sorensen-Dice Coefficient (SDC) | Intersection-over-Union | Used to gauge the similarity of two samples. Related to F1 score. | Equals twice the number of elements common to both sets divided by the sum of the number of elements in each set. | [Link](https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient) | +| Jaccard Index | Intersection-over-Union | Similar to SDC, guages the similarity and diversity of sample sets. | Equals the size of the intersection divided by the size of the union of the sample sets. | [Link](https://en.wikipedia.org/wiki/Jaccard_index) | +| Kendall Rank Correlation | Correlation and Statistical Tests | Used to measure the ordinal association between two measured quantities. | High when observations have a similar rank and low when observations have a dissimilar rank between the two variables. | [Link](https://en.wikipedia.org/wiki/Kendall_rank_correlation_coefficient) | +| Log-Likelihood Ratio | Correlation and Statistical Tests | Calculates the degree to which data supports one variable versus another. Log of the likelihood ratio, which gives the probability of correctly predicting the label in ratio to probability of incorrectly predicting label. | If likelihoods are similar, it should be close to 0. | [Link](https://en.wikipedia.org/wiki/Likelihood_function#Likelihood_ratio) | +| t-test | Correlation and Statistical Tests | Used to compare the means of two groups (pairwise). | Value looked up in t-Distribution tell if statistically significant or not. | [Link](https://en.wikipedia.org/wiki/Student's_t-test) | + +### Distribution Balance Measures + +Distribution Balance Measures allow us to compare our data with a reference distribution (currently only uniform distribution is supported as a reference distribution). They are calculated per sensitive column and do not depend on the label column. + +For example, let's assume we have a dataset with 9 rows and a Gender column, and we observe that: + +* "Male" appears 4 times +* "Female" appears 3 times +* "Other" appears 2 times + +Assuming the uniform distribution: +$$ +ReferenceCount \coloneqq \frac{numRows}{numFeatureValues} +$$ +$$ +ReferenceProbability \coloneqq \frac{1}{numFeatureValues} +$$ + +Feature Value | Observed Count | Reference Count | Observed Probability | Reference Probabiliy +| - | - | - | - | - +Male | 4 | 9/3 = 3 | 4/9 = 0.44 | 3/9 = 0.33 +Female | 3 | 9/3 = 3 | 3/9 = 0.33 | 3/9 = 0.33 +Other | 2 | 9/3 = 3 | 2/9 = 0.22 | 3/9 = 0.33 + +We can use distance measures to find out how far our observed and reference distributions of these feature values are. Some of these distance measures include: + +| Measure | Description | Interpretation | Reference | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------| +| KL Divergence | Measure of how one probability distribution is different from a second, reference probability distribution. Measure of the information gained when one revises one's beliefs from the prior probability distribution Q to the posterior probability distribution P. In other words, it is the amount of information lost when Q is used to approximate P. | Non-negative. 0 means P = Q. | [Link](https://en.wikipedia.org/wiki/Kullback%E2%80%93Leibler_divergence) | +| JS Distance | Measuring the similarity between two probability distributions. Symmetrized and smoothed version of the Kullback–Leibler (KL) divergence. Square root of JS Divergence. | Range [0, 1]. 0 means perfectly same to balanced distribution. | [Link](https://en.wikipedia.org/wiki/Jensen%E2%80%93Shannon_divergence) | +| Wasserstein Distance | This distance is also known as the earth mover’s distance, since it can be seen as the minimum amount of “work” required to transform u into v, where “work” is measured as the amount of distribution weight that must be moved, multiplied by the distance it has to be moved. | Non-negative. 0 means P = Q. | [Link](https://en.wikipedia.org/wiki/Wasserstein_metric) | +| Infinity Norm Distance | Distance between two vectors is the greatest of their differences along any coordinate dimension. Also called Chebyshev distance or chessboard distance. | Non-negative. 0 means same distribution. | [Link](https://en.wikipedia.org/wiki/Chebyshev_distance) | +| Total Variation Distance | It is equal to half the L1 (Manhattan) distance between the two distributions. Take the difference between the two proportions in each category, add up the absolute values of all the differences, and then divide the sum by 2. | Non-negative. 0 means same distribution. | [Link](https://en.wikipedia.org/wiki/Total_variation_distance_of_probability_measures) | +| Chi-Squared Test | The chi-square test tests the null hypothesis that the categorical data has the given frequencies given expected frequencies in each category. | p-value gives evidence against null-hypothesis that difference in observed and expected frequencies is by random chance. | [Link](https://en.wikipedia.org/wiki/Chi-squared_test) | + +### Aggregate Balance Measures + +Aggregate Balance Measures allow us to obtain a higher notion of inequality. They are calculated on the set of all sensitive columns and do not depend on the label column. + +These measures look at distribution of records across all combinations of sensitive columns. For example, if Sex and Race are specified as sensitive features, it then tries to quantify imbalance across all combinations of the two specified features - (Male, Black), (Female, White), (Male, Asian-Pac-Islander), etc. + +| Measure | Description | Interpretation | Reference | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| Atkinson Index | It presents the percentage of total income that a given society would have to forego in order to have more equal shares of income between its citizens. This measure depends on the degree of society aversion to inequality (a theoretical parameter decided by the researcher), where a higher value entails greater social utility or willingness by individuals to accept smaller incomes in exchange for a more equal distribution. An important feature of the Atkinson index is that it can be decomposed into within-group and between-group inequality. | Range $[0, 1]$. 0 if perfect equality. 1 means maximum inequality. In our case, it is the proportion of records for a sensitive columns’ combination. | [Link](https://en.wikipedia.org/wiki/Atkinson_index) | +| Theil T Index | GE(1) = Theil's T and is more sensitive to differences at the top of the distribution. The Theil index is a statistic used to measure economic inequality. The Theil index measures an entropic "distance" the population is away from the "ideal" egalitarian state of everyone having the same income. | If everyone has the same income, then T_T equals 0. If one person has all the income, then T_T gives the result $ln(N)$. 0 means equal income and larger values mean higher level of disproportion. | [Link](https://en.wikipedia.org/wiki/Theil_index) | +| Theil L Index | GE(0) = Theil's L and is more sensitive to differences at the lower end of the distribution. Logarithm of (mean income)/(income i), over all the incomes included in the summation. It is also referred to as the mean log deviation measure. Because a transfer from a larger income to a smaller one will change the smaller income's ratio more than it changes the larger income's ratio, the transfer-principle is satisfied by this index. | Same interpretation as Theil T Index. | [Link](https://en.wikipedia.org/wiki/Theil_index) | + +## Mitigation + +It will not be a stretch to say that every real-world dataset has caveats, biases, and imbalances. Data collection is costly. Data Imbalance mitigation or de-biasing data is an area of research. There are many techniques available at various stages of ML lifecycle i.e., during pre-processing, in-processing, and post processing. Here we outline a couple of pre-processing techniques - + +### Resampling + +This involves under-sampling from majority class and over-sampling from minority class. Most naïve way to over-sample would be duplicate records and under-sample would be to remove records at random. + +* Caveats: + + 1. Under-sampling may remove valuable information. + 2. Over-sampling may cause overfitting and poor generalization on test set. + +![Bar chart undersampling and oversampling](https://mmlspark.blob.core.windows.net/graphics/responsible_ai/DataBalanceAnalysis_SamplingBar.png) + +There are smarter techniques to under-sample and over-sample in literature and implemented in Python’s [imbalanced-learn](https://imbalanced-learn.org/stable/) package. + +For example, we can cluster the records of the majority class, and do the under-sampling by removing records from each cluster, thus seeking to preserve information. + +One technique of under-sampling is use of Tomek Links. Tomek links are pairs of very close instances but of opposite classes. Removing the instances of the majority class of each pair increases the space between the two classes, facilitating the classification process. A similar way to under-sample majority class is using Near-Miss. It first calculates the distance between all the points in the larger class with the points in the smaller class. When two points belonging to different classes are very close to each other in the distribution, this algorithm eliminates the datapoint of the larger class thereby trying to balance the distribution. + +![Tomek Links](https://mmlspark.blob.core.windows.net/graphics/responsible_ai/DataBalanceAnalysis_TomekLinks.png) + +In over-sampling, instead of creating exact copies of the minority class records, we can introduce small variations into those copies, creating more diverse synthetic samples. This technique is called SMOTE (Synthetic Minority Oversampling Technique). It randomly picks a point from the minority class and computes the k-nearest neighbors for this point. The synthetic points are added between the chosen point and its neighbors. + +![Synthetic Samples](https://mmlspark.blob.core.windows.net/graphics/responsible_ai/DataBalanceAnalysis_SyntheticSamples.png) + +### Reweighting + +There is an expected and observed value in each table cell. The weight is essentially expected / observed value. This is easy to extend to multiple features with more than 2 groups. The weights are then incorporated in loss function of model training. + +![Reweighting](https://mmlspark.blob.core.windows.net/graphics/responsible_ai/DataBalanceAnalysis_Reweight.png) diff --git a/website/versioned_docs/version-0.9.5/features/responsible_ai/DataBalanceAnalysis - Adult Census Income.md b/website/versioned_docs/version-0.9.5/features/responsible_ai/DataBalanceAnalysis - Adult Census Income.md new file mode 100644 index 0000000000..24235cf6c1 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/responsible_ai/DataBalanceAnalysis - Adult Census Income.md @@ -0,0 +1,348 @@ +--- +title: DataBalanceAnalysis - Adult Census Income +hide_title: true +status: stable +--- +## Data Balance Analysis using the Adult Census Income dataset + +In this example, we will conduct Data Balance Analysis (which consists on running three groups of measures) on the Adult Census Income dataset to determine how well features and feature values are represented in the dataset. + +This dataset can be used to predict whether annual income exceeds $50,000/year or not based on demographic data from the 1994 U.S. Census. The dataset we're reading contains 32,561 rows and 14 columns/features. + +[More info on the dataset here](https://archive.ics.uci.edu/ml/datasets/Adult) + +--- + +Data Balance Analysis is relevant for overall understanding of datasets, but it becomes essential when thinking about building Machine Learning services out of such datasets. Having a well balanced data representation is critical when developing models in a responsible way, specially in terms of fairness. +It is unfortunately all too easy to build an ML model that produces biased results for subsets of an overall population, by training or testing the model on biased ground truth data. There are multiple case studies of biased models assisting in granting loans, healthcare, recruitment opportunities and many other decision making tasks. In most of these examples, the data from which these models are trained was the common issue. These findings emphasize how important it is for model creators and auditors to analyze data balance: to measure training data across sub-populations and ensure the data has good coverage and a balanced representation of labels across sensitive categories and category combinations, and to check that test data is representative of the target population. + +In summary, Data Balance Analysis, used as a step for building ML models has the following benefits: + +* **Reduces risks for unbalanced models (facilitate service fairness) and reduces costs of ML building** by identifying early on data representation gaps that prompt data scientists to seek mitigation steps (collect more data, follow a specific sampling mechanism, create synthetic data, etc.) before proceeding to train their models. +* **Enables easy e2e debugging of ML systems** in combination with [Fairlearn](https://fairlearn.org/) by providing a clear view if for an unbalanced model the issue is tied to the data or the model. + +--- + +Note: If you are running this notebook in a Spark environment such as Azure Synapse or Databricks, then you can easily visualize the imbalance measures using the built-in plotting features. + +Python dependencies: + +```text +matplotlib==3.2.2 +numpy==1.19.2 +``` + + + +```python +import matplotlib +import matplotlib.pyplot as plt +import numpy as np +import pyspark.sql.functions as F +``` + + +```python +df = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/AdultCensusIncome.parquet") +display(df) +``` + + +```python +# Convert the "income" column from {<=50K, >50K} to {0, 1} to represent our binary classification label column +label_col = "income" +df = df.withColumn(label_col, F.when(F.col(label_col).contains("<=50K"), F.lit(0)).otherwise(F.lit(1))) +``` + +### Perform preliminary analysis on columns of interest + + +```python +display(df.groupBy("race").count()) +``` + + +```python +display(df.groupBy("sex").count()) +``` + + +```python +# Choose columns/features to do data balance analysis on +cols_of_interest = ["race", "sex"] +display(df.select(cols_of_interest + [label_col])) +``` + +### Calculate Feature Balance Measures + +Feature Balance Measures allow us to see whether each combination of sensitive feature is receiving the positive outcome (true prediction) at equal rates. + +In this context, we define a feature balance measure, also referred to as the parity, for label y as the absolute difference between the association metrics of two different sensitive classes $[x_A, x_B]$, with respect to the association metric $A(x_i, y)$. That is: + +$$parity(y \vert x_A, x_B, A(\cdot)) \coloneqq A(x_A, y) - A(x_B, y)$$ + +Using the dataset, we can see if the various sexes and races are receiving >50k income at equal or unequal rates. + +Note: Many of these metrics were influenced by this paper [Measuring Model Biases in the Absence of Ground Truth](https://arxiv.org/abs/2103.03417). + +| Association Metric | Family | Description | Interpretation/Formula | Reference | +|----------------------------------------------------|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------| +| Demographic Parity | Fairness | Proportion of each segment of a protected class (e.g. gender) should receive the positive outcome at equal rates. | As close to 0 means better parity. $DP = P(Y \vert A = "Male") - P(Y \vert A = "Female")$. | [Link](https://en.wikipedia.org/wiki/Fairness_%28machine_learning%29) | +| Pointwise Mutual Information (PMI), normalized PMI | Entropy | The PMI of a pair of feature values (ex: Gender=Male and Gender=Female) quantifies the discrepancy between the probability of their coincidence given their joint distribution and their individual distributions (assuming independence). | Range (normalized) $[-1, 1]$. -1 for no co-occurences. 0 for co-occurences at random. 1 for complete co-occurences. | [Link](https://en.wikipedia.org/wiki/Pointwise_mutual_information) | +| Sorensen-Dice Coefficient (SDC) | Intersection-over-Union | Used to gauge the similarity of two samples. Related to F1 score. | Equals twice the number of elements common to both sets divided by the sum of the number of elements in each set. | [Link](https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient) | +| Jaccard Index | Intersection-over-Union | Similar to SDC, guages the similarity and diversity of sample sets. | Equals the size of the intersection divided by the size of the union of the sample sets. | [Link](https://en.wikipedia.org/wiki/Jaccard_index) | +| Kendall Rank Correlation | Correlation and Statistical Tests | Used to measure the ordinal association between two measured quantities. | High when observations have a similar rank and low when observations have a dissimilar rank between the two variables. | [Link](https://en.wikipedia.org/wiki/Kendall_rank_correlation_coefficient) | +| Log-Likelihood Ratio | Correlation and Statistical Tests | Calculates the degree to which data supports one variable versus another. Log of the likelihood ratio, which gives the probability of correctly predicting the label in ratio to probability of incorrectly predicting label. | If likelihoods are similar, it should be close to 0. | [Link](https://en.wikipedia.org/wiki/Likelihood_function#Likelihood_ratio) | +| t-test | Correlation and Statistical Tests | Used to compare the means of two groups (pairwise). | Value looked up in t-Distribution tell if statistically significant or not. | [Link](https://en.wikipedia.org/wiki/Student's_t-test) | + + +```python +from synapse.ml.exploratory import FeatureBalanceMeasure + +feature_balance_measures = ( + FeatureBalanceMeasure() + .setSensitiveCols(cols_of_interest) + .setLabelCol(label_col) + .setVerbose(True) + .transform(df) +) + +# Sort by Demographic Parity descending for all features +display(feature_balance_measures.sort(F.abs("FeatureBalanceMeasure.dp").desc())) +``` + + +```python +# Drill down to feature == "sex" +display(feature_balance_measures.filter(F.col("FeatureName") == "sex").sort(F.abs("FeatureBalanceMeasure.dp").desc())) +``` + + +```python +# Drill down to feature == "race" +display(feature_balance_measures.filter(F.col("FeatureName") == "race").sort(F.abs("FeatureBalanceMeasure.dp").desc())) +``` + +#### Visualize Feature Balance Measures + + +```python +races = [row["race"] for row in df.groupBy("race").count().select("race").collect()] +dp_rows = feature_balance_measures.filter(F.col("FeatureName") == "race").select("ClassA", "ClassB", "FeatureBalanceMeasure.dp").collect() +race_dp_values = [(row["ClassA"], row["ClassB"], row["dp"]) for row in dp_rows] + +race_dp_array = np.zeros((len(races), len(races))) +for class_a, class_b, dp_value in race_dp_values: + i, j = races.index(class_a), races.index(class_b) + dp_value = round(dp_value, 2) + race_dp_array[i, j] = dp_value + race_dp_array[j, i] = -1 * dp_value + +colormap = "RdBu" +dp_min, dp_max = -1.0, 1.0 + +fig, ax = plt.subplots() +im = ax.imshow(race_dp_array, vmin=dp_min, vmax=dp_max, cmap=colormap) + +cbar = ax.figure.colorbar(im, ax=ax) +cbar.ax.set_ylabel("Demographic Parity", rotation=-90, va="bottom") + +ax.set_xticks(np.arange(len(races))) +ax.set_yticks(np.arange(len(races))) +ax.set_xticklabels(races) +ax.set_yticklabels(races) + +plt.setp(ax.get_xticklabels(), rotation=45, ha="right", rotation_mode="anchor") + +for i in range(len(races)): + for j in range(len(races)): + text = ax.text(j, i, race_dp_array[i, j], ha="center", va="center", color="k") + +ax.set_title("Demographic Parity of Races in Adult Dataset") +fig.tight_layout() +plt.show() +``` + +![Demographic Parity of Races in Adult Dataset](https://mmlspark.blob.core.windows.net/graphics/responsible_ai/DataBalanceAnalysis_AdultCensusIncome_RacesDP.png) + +#### Interpret Feature Balance Measures + +Demographic Parity: +* When it is positive, it means that ClassA sees the positive outcome more than ClassB. +* When it is negative, it means that ClassB sees the positive outcome more than ClassA. + +--- + +From the results, we can tell the following: + +For Sex: +* DP(Male, Female) = 0.1963 shows "Male" observations are associated with ">50k" income label more often than "Female" observations. + +For Race: +* DP(Other, Asian-Pac-Islander) = -0.1734 shows "Other" observations are associated with ">50k" income label less than "Asian-Pac-Islander" observations. +* DP(White, Other) = 0.1636 shows "White" observations are associated with ">50k" income label more often than "Other" observations. +* DP(Asian-Pac-Islander, Amer-Indian-Eskimo) = 0.1494 shows "Asian-Pac-Islander" observations are associated with ">50k" income label more often than "Amer-Indian-Eskimo" observations. + +Again, you can take mitigation steps to upsample/downsample your data to be less biased towards certain features and feature values. + +Built-in mitigation steps are coming soon. + +### Calculate Distribution Balance Measures + +Distribution Balance Measures allow us to compare our data with a reference distribution (i.e. uniform distribution). They are calculated per sensitive column and don't use the label column. + +For example, let's assume we have a dataset with 9 rows and a Gender column, and we observe that: +* "Male" appears 4 times +* "Female" appears 3 times +* "Other" appears 2 times + +Assuming the uniform distribution: +$$ +ReferenceCount \coloneqq \frac{numRows}{numFeatureValues} +$$ +$$ +ReferenceProbability \coloneqq \frac{1}{numFeatureValues} +$$ + +| Feature Value | Observed Count | Reference Count | Observed Probability | Reference Probability | +|---------------|----------------|-----------------|----------------------|-----------------------| +| Male | 4 | 9/3 = 3 | 4/9 = 0.44 | 3/9 = 0.33 | +| Female | 3 | 9/3 = 3 | 3/9 = 0.33 | 3/9 = 0.33 | +| Other | 2 | 9/3 = 3 | 2/9 = 0.22 | 3/9 = 0.33 | + +We can use distance measures to find out how far our observed and reference distributions of these feature values are. Some of these distance measures include: + +| Measure | Description | Interpretation | Reference | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------| +| KL Divergence | Measure of how one probability distribution is different from a second, reference probability distribution. Measure of the information gained when one revises one's beliefs from the prior probability distribution Q to the posterior probability distribution P. In other words, it is the amount of information lost when Q is used to approximate P. | Non-negative. 0 means P = Q. | [Link](https://en.wikipedia.org/wiki/Kullback%E2%80%93Leibler_divergence) | +| JS Distance | Measuring the similarity between two probability distributions. Symmetrized and smoothed version of the Kullback–Leibler (KL) divergence. Square root of JS Divergence. | Range [0, 1]. 0 means perfectly same to balanced distribution. | [Link](https://en.wikipedia.org/wiki/Jensen%E2%80%93Shannon_divergence) | +| Wasserstein Distance | This distance is also known as the earth mover’s distance, since it can be seen as the minimum amount of “work” required to transform u into v, where “work” is measured as the amount of distribution weight that must be moved, multiplied by the distance it has to be moved. | Non-negative. 0 means P = Q. | [Link](https://en.wikipedia.org/wiki/Wasserstein_metric) | +| Infinity Norm Distance | Distance between two vectors is the greatest of their differences along any coordinate dimension. Also called Chebyshev distance or chessboard distance. | Non-negative. 0 means same distribution. | [Link](https://en.wikipedia.org/wiki/Chebyshev_distance) | +| Total Variation Distance | It is equal to half the L1 (Manhattan) distance between the two distributions. Take the difference between the two proportions in each category, add up the absolute values of all the differences, and then divide the sum by 2. | Non-negative. 0 means same distribution. | [Link](https://en.wikipedia.org/wiki/Total_variation_distance_of_probability_measures) | +| Chi-Squared Test | The chi-square test tests the null hypothesis that the categorical data has the given frequencies given expected frequencies in each category. | p-value gives evidence against null-hypothesis that difference in observed and expected frequencies is by random chance. | [Link](https://en.wikipedia.org/wiki/Chi-squared_test) | + + +```python +from synapse.ml.exploratory import DistributionBalanceMeasure + +distribution_balance_measures = ( + DistributionBalanceMeasure() + .setSensitiveCols(cols_of_interest) + .transform(df) +) + +# Sort by JS Distance descending +display(distribution_balance_measures.sort(F.abs("DistributionBalanceMeasure.js_dist").desc())) +``` + +#### Visualize Distribution Balance Measures + + +```python +distribution_rows = distribution_balance_measures.collect() +race_row = [row for row in distribution_rows if row["FeatureName"] == "race"][0]["DistributionBalanceMeasure"] +sex_row = [row for row in distribution_rows if row["FeatureName"] == "sex"][0]["DistributionBalanceMeasure"] + +measures_of_interest = ["kl_divergence", "js_dist", "inf_norm_dist", "total_variation_dist", "wasserstein_dist"] +race_measures = [round(race_row[measure], 4) for measure in measures_of_interest] +sex_measures = [round(sex_row[measure], 4) for measure in measures_of_interest] + +x = np.arange(len(measures_of_interest)) +width = 0.35 + +fig, ax = plt.subplots() +rects1 = ax.bar(x - width/2, race_measures, width, label="Race") +rects2 = ax.bar(x + width/2, sex_measures, width, label="Sex") + +ax.set_xlabel("Measure") +ax.set_ylabel("Value") +ax.set_title("Distribution Balance Measures of Sex and Race in Adult Dataset") +ax.set_xticks(x) +ax.set_xticklabels(measures_of_interest) +ax.legend() + +plt.setp(ax.get_xticklabels(), rotation=20, ha="right", rotation_mode="default") + +def autolabel(rects): + for rect in rects: + height = rect.get_height() + ax.annotate('{}'.format(height), + xy=(rect.get_x() + rect.get_width() / 2, height), + xytext=(0, 1), # 1 point vertical offset + textcoords="offset points", + ha='center', va='bottom') + +autolabel(rects1) +autolabel(rects2) + +fig.tight_layout() + +plt.show() +``` + +![Distribution Balance Measures of Sex and Race in Adult Dataset](https://mmlspark.blob.core.windows.net/graphics/responsible_ai/DataBalanceAnalysis_AdultCensusIncome_DistributionMeasures.png) + +#### Interpret Distribution Balance Measures + +Race has a JS Distance of 0.5104 while Sex has a JS Distance of 0.1217. + +Knowing that JS Distance is between [0, 1] where 0 means perfectly balanced distribution, we can tell that: +* There is a larger disparity between various races than various sexes in our dataset. +* Race is nowhere close to a perfectly balanced distribution (i.e. some races are seen ALOT more than others in our dataset). +* Sex is fairly close to a perfectly balanced distribution. + +### Calculate Aggregate Balance Measures + +Aggregate Balance Measures allow us to obtain a higher notion of inequality. They are calculated on the global set of sensitive columns and don't use the label column. + +These measures look at distribution of records across all combinations of sensitive columns. For example, if Sex and Race are sensitive columns, it shall try to quantify imbalance across all combinations - (Male, Black), (Female, White), (Male, Asian-Pac-Islander), etc. + +| Measure | Description | Interpretation | Reference | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| Atkinson Index | It presents the percentage of total income that a given society would have to forego in order to have more equal shares of income between its citizens. This measure depends on the degree of society aversion to inequality (a theoretical parameter decided by the researcher), where a higher value entails greater social utility or willingness by individuals to accept smaller incomes in exchange for a more equal distribution. An important feature of the Atkinson index is that it can be decomposed into within-group and between-group inequality. | Range $[0, 1]$. 0 if perfect equality. 1 means maximum inequality. In our case, it is the proportion of records for a sensitive columns’ combination. | [Link](https://en.wikipedia.org/wiki/Atkinson_index) | +| Theil T Index | GE(1) = Theil's T and is more sensitive to differences at the top of the distribution. The Theil index is a statistic used to measure economic inequality. The Theil index measures an entropic "distance" the population is away from the "ideal" egalitarian state of everyone having the same income. | If everyone has the same income, then T_T equals 0. If one person has all the income, then T_T gives the result $ln(N)$. 0 means equal income and larger values mean higher level of disproportion. | [Link](https://en.wikipedia.org/wiki/Theil_index) | +| Theil L Index | GE(0) = Theil's L and is more sensitive to differences at the lower end of the distribution. Logarithm of (mean income)/(income i), over all the incomes included in the summation. It is also referred to as the mean log deviation measure. Because a transfer from a larger income to a smaller one will change the smaller income's ratio more than it changes the larger income's ratio, the transfer-principle is satisfied by this index. | Same interpretation as Theil T Index. | [Link](https://en.wikipedia.org/wiki/Theil_index) | + + +```python +from synapse.ml.exploratory import AggregateBalanceMeasure + +aggregate_balance_measures = ( + AggregateBalanceMeasure() + .setSensitiveCols(cols_of_interest) + .transform(df) +) + +display(aggregate_balance_measures) +``` + +#### Interpret Aggregate Balance Measures + +An Atkinson Index of 0.7779 lets us know that 77.79% of data points need to be foregone to have a more equal share among our features. + +It lets us know that our dataset is leaning towards maximum inequality, and we should take actionable steps to: +* Upsample data points where the feature value is barely observed. +* Downsample data points where the feature value is observed much more than others. + +### Summary + +Throughout the course of this sample notebook, we have: +1. Chosen "Race" and "Sex" as columns of interest in the Adult Census Income dataset. +2. Done preliminary analysis on our dataset. +3. Ran the 3 groups of measures that compose our **Data Balance Analysis**: + * **Feature Balance Measures** + * Calculated Feature Balance Measures to see that the highest Demographic Parity is in "Sex": Males see >50k income much more than Females. + * Visualized Demographic Parity of Races to see that Asian-Pac-Islander sees >50k income much more than Other, in addition to other race combinations. + * **Distribution Balance Measures** + * Calculated Distribution Balance Measures to see that "Sex" is much closer to a perfectly balanced distribution than "Race". + * Visualized various distribution balance measures to compare their values for "Race" and "Sex". + * **Aggregate Balance Measures** + * Calculated Aggregate Balance Measures to see that we need to forego 77.79% of data points to have a perfectly balanced dataset. We identified that our dataset is leaning towards maximum inequality, and we should take actionable steps to: + * Upsample data points where the feature value is barely observed. + * Downsample data points where the feature value is observed much more than others. + +**In conclusion:** +* These measures provide an indicator of disparity on the data, allowing for users to explore potential mitigations before proceeding to train. +* Users can use these measures to set thresholds on their level of "tolerance" for data representation. +* Production pipelines can use these measures as baseline for models that require frequent retraining on new data. +* These measures can also be saved as key metadata for the model/service built and added as part of model cards or transparency notes helping drive overall accountability for the ML service built and its performance across different demographics or sensitive attributes. diff --git a/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Explanation Dashboard.md b/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Explanation Dashboard.md new file mode 100644 index 0000000000..f7db34ed1c --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Explanation Dashboard.md @@ -0,0 +1,191 @@ +--- +title: Interpretability - Explanation Dashboard +hide_title: true +status: stable +--- +## Interpretability - Explanation Dashboard + +In this example, similar to the "Interpretability - Tabular SHAP explainer" notebook, we use Kernel SHAP to explain a tabular classification model built from the Adults Census dataset and then visualize the explanation in the ExplanationDashboard from https://github.com/microsoft/responsible-ai-widgets. + +First we import the packages and define some UDFs we will need later. + + +```python +import pyspark +from synapse.ml.explainers import * +from pyspark.ml import Pipeline +from pyspark.ml.classification import LogisticRegression +from pyspark.ml.feature import StringIndexer, OneHotEncoder, VectorAssembler +from pyspark.sql.types import * +from pyspark.sql.functions import * +import pandas as pd + +vec_access = udf(lambda v, i: float(v[i]), FloatType()) +vec2array = udf(lambda vec: vec.toArray().tolist(), ArrayType(FloatType())) +``` + +Now let's read the data and train a simple binary classification model. + + +```python +df = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/AdultCensusIncome.parquet").cache() + +labelIndexer = StringIndexer(inputCol="income", outputCol="label", stringOrderType="alphabetAsc").fit(df) +print("Label index assigment: " + str(set(zip(labelIndexer.labels, [0, 1])))) + +training = labelIndexer.transform(df) +display(training) +categorical_features = [ + "workclass", + "education", + "marital-status", + "occupation", + "relationship", + "race", + "sex", + "native-country", +] +categorical_features_idx = [col + "_idx" for col in categorical_features] +categorical_features_enc = [col + "_enc" for col in categorical_features] +numeric_features = ["age", "education-num", "capital-gain", "capital-loss", "hours-per-week"] + +strIndexer = StringIndexer(inputCols=categorical_features, outputCols=categorical_features_idx) +onehotEnc = OneHotEncoder(inputCols=categorical_features_idx, outputCols=categorical_features_enc) +vectAssem = VectorAssembler(inputCols=categorical_features_enc + numeric_features, outputCol="features") +lr = LogisticRegression(featuresCol="features", labelCol="label", weightCol="fnlwgt") +pipeline = Pipeline(stages=[strIndexer, onehotEnc, vectAssem, lr]) +model = pipeline.fit(training) +``` + +After the model is trained, we randomly select some observations to be explained. + + +```python +explain_instances = model.transform(training).orderBy(rand()).limit(5).repartition(200).cache() +display(explain_instances) +``` + +We create a TabularSHAP explainer, set the input columns to all the features the model takes, specify the model and the target output column we are trying to explain. In this case, we are trying to explain the "probability" output which is a vector of length 2, and we are only looking at class 1 probability. Specify targetClasses to `[0, 1]` if you want to explain class 0 and 1 probability at the same time. Finally we sample 100 rows from the training data for background data, which is used for integrating out features in Kernel SHAP. + + +```python +shap = TabularSHAP( + inputCols=categorical_features + numeric_features, + outputCol="shapValues", + numSamples=5000, + model=model, + targetCol="probability", + targetClasses=[1], + backgroundData=broadcast(training.orderBy(rand()).limit(100).cache()), +) + +shap_df = shap.transform(explain_instances) + +``` + +Once we have the resulting dataframe, we extract the class 1 probability of the model output, the SHAP values for the target class, the original features and the true label. Then we convert it to a pandas dataframe for visisualization. +For each observation, the first element in the SHAP values vector is the base value (the mean output of the background dataset), and each of the following element is the SHAP values for each feature. + + +```python +shaps = ( + shap_df.withColumn("probability", vec_access(col("probability"), lit(1))) + .withColumn("shapValues", vec2array(col("shapValues").getItem(0))) + .select(["shapValues", "probability", "label"] + categorical_features + numeric_features) +) + +shaps_local = shaps.toPandas() +shaps_local.sort_values("probability", ascending=False, inplace=True, ignore_index=True) +pd.set_option("display.max_colwidth", None) +shaps_local +``` + +We can visualize the explanation in the [interpret-community format](https://github.com/interpretml/interpret-community) in the ExplanationDashboard from https://github.com/microsoft/responsible-ai-widgets/ + + +```python +import pandas as pd +import numpy as np + +features = categorical_features + numeric_features +features_with_base = ["Base"] + features + +rows = shaps_local.shape[0] + +local_importance_values = shaps_local[['shapValues']] +eval_data = shaps_local[features] +true_y = np.array(shaps_local[['label']]) +``` + + +```python +list_local_importance_values = local_importance_values.values.tolist() +converted_importance_values = [] +bias = [] +for classarray in list_local_importance_values: + for rowarray in classarray: + converted_list = rowarray.tolist() + bias.append(converted_list[0]) + # remove the bias from local importance values + del converted_list[0] + converted_importance_values.append(converted_list) +``` + +When running Synapse Analytics, please follow instructions here [Package management - Azure Synapse Analytics | Microsoft Docs](https://docs.microsoft.com/en-us/azure/synapse-analytics/spark/apache-spark-azure-portal-add-libraries) to install ["raiwidgets"](https://pypi.org/project/raiwidgets/) and ["interpret-community"](https://pypi.org/project/interpret-community/) packages. + + +```python +!pip install --upgrade raiwidgets +``` + + +```python +!pip install --upgrade interpret-community +``` + + +```python +from interpret_community.adapter import ExplanationAdapter +adapter = ExplanationAdapter(features, classification=True) +global_explanation = adapter.create_global(converted_importance_values, eval_data, expected_values=bias) +``` + + +```python +# view the global importance values +global_explanation.global_importance_values +``` + + +```python +# view the local importance values +global_explanation.local_importance_values +``` + + +```python +class wrapper(object): + def __init__(self, model): + self.model = model + + def predict(self, data): + sparkdata = spark.createDataFrame(data) + return model.transform(sparkdata).select('prediction').toPandas().values.flatten().tolist() + + def predict_proba(self, data): + sparkdata = spark.createDataFrame(data) + prediction = model.transform(sparkdata).select('probability').toPandas().values.flatten().tolist() + proba_list = [vector.values.tolist() for vector in prediction] + return proba_list +``` + + +```python +# view the explanation in the ExplanationDashboard +from raiwidgets import ExplanationDashboard +ExplanationDashboard(global_explanation, wrapper(model), dataset=eval_data, true_y=true_y) +``` + +Your results will look like: + + diff --git a/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Image Explainers.md b/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Image Explainers.md new file mode 100644 index 0000000000..ca1048c138 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Image Explainers.md @@ -0,0 +1,192 @@ +--- +title: Interpretability - Image Explainers +hide_title: true +status: stable +--- +## Interpretability - Image Explainers + +In this example, we use LIME and Kernel SHAP explainers to explain the ResNet50 model's multi-class output of an image. + +First we import the packages and define some UDFs and a plotting function we will need later. + + +```python +from synapse.ml.explainers import * +from synapse.ml.onnx import ONNXModel +from synapse.ml.opencv import ImageTransformer +from synapse.ml.io import * +from pyspark.ml import Pipeline +from pyspark.ml.classification import LogisticRegression +from pyspark.ml.feature import StringIndexer +from pyspark.sql.functions import * +from pyspark.sql.types import * +import numpy as np +import pyspark +import urllib.request +import matplotlib.pyplot as plt +import PIL, io +from PIL import Image + +vec_slice = udf(lambda vec, indices: (vec.toArray())[indices].tolist(), ArrayType(FloatType())) +arg_top_k = udf(lambda vec, k: (-vec.toArray()).argsort()[:k].tolist(), ArrayType(IntegerType())) + +def downloadBytes(url: str): + with urllib.request.urlopen(url) as url: + barr = url.read() + return barr + +def rotate_color_channel(bgr_image_array, height, width, nChannels): + B, G, R, *_ = np.asarray(bgr_image_array).reshape(height, width, nChannels).T + rgb_image_array = np.array((R, G, B)).T + return rgb_image_array + +def plot_superpixels(image_rgb_array, sp_clusters, weights, green_threshold=99): + superpixels = sp_clusters + green_value = np.percentile(weights, green_threshold) + img = Image.fromarray(image_rgb_array, mode='RGB').convert("RGBA") + image_array = np.asarray(img).copy() + for (sp, v) in zip(superpixels, weights): + if v > green_value: + for (x, y) in sp: + image_array[y, x, 1] = 255 + image_array[y, x, 3] = 200 + plt.clf() + plt.imshow(image_array) + display() +``` + +Create a dataframe for a testing image, and use the ResNet50 ONNX model to infer the image. + +The result shows 39.6% probability of "violin" (889), and 38.4% probability of "upright piano" (881). + + +```python +from synapse.ml.io import * + +image_df = spark.read.image().load("wasbs://publicwasb@mmlspark.blob.core.windows.net/explainers/images/david-lusvardi-dWcUncxocQY-unsplash.jpg") +display(image_df) + +# Rotate the image array from BGR into RGB channels for visualization later. +row = image_df.select("image.height", "image.width", "image.nChannels", "image.data").head() +locals().update(row.asDict()) +rgb_image_array = rotate_color_channel(data, height, width, nChannels) + +# Download the ONNX model +modelPayload = downloadBytes("https://mmlspark.blob.core.windows.net/publicwasb/ONNXModels/resnet50-v2-7.onnx") + +featurizer = ( + ImageTransformer(inputCol="image", outputCol="features") + .resize(224, True) + .centerCrop(224, 224) + .normalize(mean=[0.485, 0.456, 0.406], std=[0.229, 0.224, 0.225], color_scale_factor = 1/255) + .setTensorElementType(FloatType()) +) + +onnx = ( + ONNXModel() + .setModelPayload(modelPayload) + .setFeedDict({"data": "features"}) + .setFetchDict({"rawPrediction": "resnetv24_dense0_fwd"}) + .setSoftMaxDict({"rawPrediction": "probability"}) + .setMiniBatchSize(1) +) + +model = Pipeline(stages=[featurizer, onnx]).fit(image_df) +``` + + +```python +predicted = ( + model.transform(image_df) + .withColumn("top2pred", arg_top_k(col("probability"), lit(2))) + .withColumn("top2prob", vec_slice(col("probability"), col("top2pred"))) +) + +display(predicted.select("top2pred", "top2prob")) +``` + +First we use the LIME image explainer to explain the model's top 2 classes' probabilities. + + +```python +lime = ( + ImageLIME() + .setModel(model) + .setOutputCol("weights") + .setInputCol("image") + .setCellSize(150.0) + .setModifier(50.0) + .setNumSamples(500) + .setTargetCol("probability") + .setTargetClassesCol("top2pred") + .setSamplingFraction(0.7) +) + +lime_result = ( + lime.transform(predicted) + .withColumn("weights_violin", col("weights").getItem(0)) + .withColumn("weights_piano", col("weights").getItem(1)) + .cache() +) + +display(lime_result.select(col("weights_violin"), col("weights_piano"))) +lime_row = lime_result.head() +``` + +We plot the LIME weights for "violin" output and "upright piano" output. + +Green area are superpixels with LIME weights above 95 percentile. + + +```python +plot_superpixels(rgb_image_array, lime_row["superpixels"]["clusters"], list(lime_row["weights_violin"]), 95) +plot_superpixels(rgb_image_array, lime_row["superpixels"]["clusters"], list(lime_row["weights_piano"]), 95) +``` + +Your results will look like: + + + +Then we use the Kernel SHAP image explainer to explain the model's top 2 classes' probabilities. + + +```python +shap = ( + ImageSHAP() + .setModel(model) + .setOutputCol("shaps") + .setSuperpixelCol("superpixels") + .setInputCol("image") + .setCellSize(150.0) + .setModifier(50.0) + .setNumSamples(500) + .setTargetCol("probability") + .setTargetClassesCol("top2pred") +) + +shap_result = ( + shap.transform(predicted) + .withColumn("shaps_violin", col("shaps").getItem(0)) + .withColumn("shaps_piano", col("shaps").getItem(1)) + .cache() +) + +display(shap_result.select(col("shaps_violin"), col("shaps_piano"))) +shap_row = shap_result.head() +``` + +We plot the SHAP values for "piano" output and "cell" output. + +Green area are superpixels with SHAP values above 95 percentile. + +> Notice that we drop the base value from the SHAP output before rendering the superpixels. The base value is the model output for the background (all black) image. + + +```python +plot_superpixels(rgb_image_array, shap_row["superpixels"]["clusters"], list(shap_row["shaps_violin"][1:]), 95) +plot_superpixels(rgb_image_array, shap_row["superpixels"]["clusters"], list(shap_row["shaps_piano"][1:]), 95) +``` + +Your results will look like: + + diff --git a/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Snow Leopard Detection.md b/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Snow Leopard Detection.md new file mode 100644 index 0000000000..5740c315ce --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Snow Leopard Detection.md @@ -0,0 +1,230 @@ +--- +title: Interpretability - Snow Leopard Detection +hide_title: true +status: stable +--- +## Automated Snow Leopard Detection with Synapse Machine Learning + + + + +```python +import os +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() + from notebookutils.mssparkutils.credentials import getSecret + os.environ["BING_IMAGE_SEARCH_KEY"] = getSecret("mmlspark-keys", "bing-image-search-key") + +# WARNING this notebook requires alot of memory. +# If you get a heap space error, try dropping the number of images bing returns +# or by writing out the images to parquet first + +# Replace the following with a line like: BING_IMAGE_SEARCH_KEY = "hdwo2oyd3o928s....." +BING_IMAGE_SEARCH_KEY = os.environ["BING_IMAGE_SEARCH_KEY"] +``` + + +```python +from synapse.ml.cognitive import * +from synapse.ml.core.spark import FluentAPI +from pyspark.sql.functions import lit + +def bingPhotoSearch(name, queries, pages): + offsets = [offset*10 for offset in range(0, pages)] + parameters = [(query, offset) for offset in offsets for query in queries] + + return spark.createDataFrame(parameters, ("queries","offsets")) \ + .mlTransform( + BingImageSearch() # Apply Bing Image Search + .setSubscriptionKey(BING_IMAGE_SEARCH_KEY) # Set the API Key + .setOffsetCol("offsets") # Specify a column containing the offsets + .setQueryCol("queries") # Specify a column containing the query words + .setCount(10) # Specify the number of images to return per offset + .setImageType("photo") # Specify a filter to ensure we get photos + .setOutputCol("images")) \ + .mlTransform(BingImageSearch.getUrlTransformer("images", "urls")) \ + .withColumn("labels", lit(name)) \ + .limit(400) + +``` + + + + +```python +def displayDF(df, n=5, image_cols = set(["urls"])): + rows = df.take(n) + cols = df.columns + header = "".join(["" + c + "" for c in cols]) + + style = """ + + + + +""" + + table = [] + for row in rows: + table.append("") + for col in cols: + if col in image_cols: + rep = ''.format(row[col]) + else: + rep = row[col] + table.append("{}".format(rep)) + table.append("") + tableHTML = "".join(table) + + body = """ + + + + {} + + {} +
+ + + """.format(header, tableHTML) + try: + displayHTML(style + body) + except: + pass +``` + + +```python +snowLeopardQueries = ["snow leopard"] +snowLeopardUrls = bingPhotoSearch("snow leopard", snowLeopardQueries, pages=100) +displayDF(snowLeopardUrls) +``` + + +```python +randomWords = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/random_words.parquet").cache() +randomWords.show() +``` + + +```python +randomLinks = randomWords \ + .mlTransform(BingImageSearch() + .setSubscriptionKey(BING_IMAGE_SEARCH_KEY) + .setCount(10) + .setQueryCol("words") + .setOutputCol("images")) \ + .mlTransform(BingImageSearch.getUrlTransformer("images", "urls")) \ + .withColumn("label", lit("other")) \ + .limit(400) + +displayDF(randomLinks) +``` + + +```python +images = snowLeopardUrls.union(randomLinks).distinct().repartition(100)\ + .mlTransform(BingImageSearch.downloadFromUrls("urls", "image", concurrency=5, timeout=5000))\ + .dropna() + +train, test = images.randomSplit([.7,.3], seed=1) +``` + + +```python +from pyspark.ml import Pipeline +from pyspark.ml.feature import StringIndexer +from pyspark.ml.classification import LogisticRegression +from pyspark.sql.functions import udf +from synapse.ml.downloader import ModelDownloader +from synapse.ml.cntk import ImageFeaturizer +from synapse.ml.stages import UDFTransformer +from pyspark.sql.types import * + +def getIndex(row): + return float(row[1]) + +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + network = ModelDownloader(spark, "abfss://synapse@mmlsparkeuap.dfs.core.windows.net/models/").downloadByName("ResNet50") +else: + network = ModelDownloader(spark, "dbfs:/Models/").downloadByName("ResNet50") + +model = Pipeline(stages=[ + StringIndexer(inputCol = "labels", outputCol="index"), + ImageFeaturizer(inputCol="image", outputCol="features", cutOutputLayers=1).setModel(network), + LogisticRegression(maxIter=5, labelCol="index", regParam=10.0), + UDFTransformer()\ + .setUDF(udf(getIndex, DoubleType()))\ + .setInputCol("probability")\ + .setOutputCol("leopard_prob") +]) + +fitModel = model.fit(train) +``` + + + + +```python +def plotConfusionMatrix(df, label, prediction, classLabels): + from synapse.ml.plot import confusionMatrix + import matplotlib.pyplot as plt + fig = plt.figure(figsize=(4.5, 4.5)) + confusionMatrix(df, label, prediction, classLabels) + display(fig) + +if os.environ.get("AZURE_SERVICE", None) != "Microsoft.ProjectArcadia": + plotConfusionMatrix(fitModel.transform(test), "index", "prediction", fitModel.stages[0].labels) +``` + + +```python +import urllib.request +from synapse.ml.lime import ImageLIME + +test_image_url = "https://mmlspark.blob.core.windows.net/graphics/SnowLeopardAD/snow_leopard1.jpg" +with urllib.request.urlopen(test_image_url) as url: + barr = url.read() +test_subsample = spark.createDataFrame([(bytearray(barr),)], ["image"]) + +lime = ImageLIME()\ + .setModel(fitModel)\ + .setPredictionCol("leopard_prob")\ + .setOutputCol("weights")\ + .setInputCol("image")\ + .setCellSize(100.0)\ + .setModifier(50.0)\ + .setNSamples(300) + +result = lime.transform(test_subsample) +``` + + +```python +import matplotlib.pyplot as plt +import PIL, io, numpy as np + +def plot_superpixels(row): + image_bytes = row['image'] + superpixels = row['superpixels']['clusters'] + weights = list(row['weights']) + mean_weight = np.percentile(weights,90) + img = (PIL.Image.open(io.BytesIO(image_bytes))).convert('RGBA') + image_array = np.asarray(img).copy() + for (sp, w) in zip(superpixels, weights): + if w > mean_weight: + for (x, y) in sp: + image_array[y, x, 1] = 255 + image_array[y, x, 3] = 200 + plt.clf() + plt.imshow(image_array) + display() + +# Gets first row from the LIME-transformed data frame +if os.environ.get("AZURE_SERVICE", None) != "Microsoft.ProjectArcadia": + plot_superpixels(result.take(1)[0]) +``` + +### Your results will look like: + diff --git a/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Tabular SHAP explainer.md b/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Tabular SHAP explainer.md new file mode 100644 index 0000000000..d1afe88ebf --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Tabular SHAP explainer.md @@ -0,0 +1,142 @@ +--- +title: Interpretability - Tabular SHAP explainer +hide_title: true +status: stable +--- +## Interpretability - Tabular SHAP explainer + +In this example, we use Kernel SHAP to explain a tabular classification model built from the Adults Census dataset. + +First we import the packages and define some UDFs we will need later. + + +```python +import pyspark +from synapse.ml.explainers import * +from pyspark.ml import Pipeline +from pyspark.ml.classification import LogisticRegression +from pyspark.ml.feature import StringIndexer, OneHotEncoder, VectorAssembler +from pyspark.sql.types import * +from pyspark.sql.functions import * +import pandas as pd + +vec_access = udf(lambda v, i: float(v[i]), FloatType()) +vec2array = udf(lambda vec: vec.toArray().tolist(), ArrayType(FloatType())) +``` + +Now let's read the data and train a simple binary classification model. + + +```python +df = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/AdultCensusIncome.parquet") + +labelIndexer = StringIndexer(inputCol="income", outputCol="label", stringOrderType="alphabetAsc").fit(df) +print("Label index assigment: " + str(set(zip(labelIndexer.labels, [0, 1])))) + +training = labelIndexer.transform(df).cache() +display(training) +categorical_features = [ + "workclass", + "education", + "marital-status", + "occupation", + "relationship", + "race", + "sex", + "native-country", +] +categorical_features_idx = [col + "_idx" for col in categorical_features] +categorical_features_enc = [col + "_enc" for col in categorical_features] +numeric_features = ["age", "education-num", "capital-gain", "capital-loss", "hours-per-week"] + +strIndexer = StringIndexer(inputCols=categorical_features, outputCols=categorical_features_idx) +onehotEnc = OneHotEncoder(inputCols=categorical_features_idx, outputCols=categorical_features_enc) +vectAssem = VectorAssembler(inputCols=categorical_features_enc + numeric_features, outputCol="features") +lr = LogisticRegression(featuresCol="features", labelCol="label", weightCol="fnlwgt") +pipeline = Pipeline(stages=[strIndexer, onehotEnc, vectAssem, lr]) +model = pipeline.fit(training) +``` + +After the model is trained, we randomly select some observations to be explained. + + +```python +explain_instances = model.transform(training).orderBy(rand()).limit(5).repartition(200).cache() +display(explain_instances) +``` + +We create a TabularSHAP explainer, set the input columns to all the features the model takes, specify the model and the target output column we are trying to explain. In this case, we are trying to explain the "probability" output which is a vector of length 2, and we are only looking at class 1 probability. Specify targetClasses to `[0, 1]` if you want to explain class 0 and 1 probability at the same time. Finally we sample 100 rows from the training data for background data, which is used for integrating out features in Kernel SHAP. + + +```python +shap = TabularSHAP( + inputCols=categorical_features + numeric_features, + outputCol="shapValues", + numSamples=5000, + model=model, + targetCol="probability", + targetClasses=[1], + backgroundData=broadcast(training.orderBy(rand()).limit(100).cache()), +) + +shap_df = shap.transform(explain_instances) + +``` + +Once we have the resulting dataframe, we extract the class 1 probability of the model output, the SHAP values for the target class, the original features and the true label. Then we convert it to a pandas dataframe for visisualization. +For each observation, the first element in the SHAP values vector is the base value (the mean output of the background dataset), and each of the following element is the SHAP values for each feature. + + +```python +shaps = ( + shap_df.withColumn("probability", vec_access(col("probability"), lit(1))) + .withColumn("shapValues", vec2array(col("shapValues").getItem(0))) + .select(["shapValues", "probability", "label"] + categorical_features + numeric_features) +) + +shaps_local = shaps.toPandas() +shaps_local.sort_values("probability", ascending=False, inplace=True, ignore_index=True) +pd.set_option("display.max_colwidth", None) +shaps_local +``` + +We use plotly subplot to visualize the SHAP values. + + +```python +from plotly.subplots import make_subplots +import plotly.graph_objects as go +import pandas as pd + +features = categorical_features + numeric_features +features_with_base = ["Base"] + features + +rows = shaps_local.shape[0] + +fig = make_subplots( + rows=rows, + cols=1, + subplot_titles="Probability: " + shaps_local["probability"].apply("{:.2%}".format) + "; Label: " + shaps_local["label"].astype(str), +) + +for index, row in shaps_local.iterrows(): + feature_values = [0] + [row[feature] for feature in features] + shap_values = row["shapValues"] + list_of_tuples = list(zip(features_with_base, feature_values, shap_values)) + shap_pdf = pd.DataFrame(list_of_tuples, columns=["name", "value", "shap"]) + fig.add_trace( + go.Bar(x=shap_pdf["name"], y=shap_pdf["shap"], hovertext="value: " + shap_pdf["value"].astype(str)), + row=index + 1, + col=1, + ) + +fig.update_yaxes(range=[-1, 1], fixedrange=True, zerolinecolor="black") +fig.update_xaxes(type="category", tickangle=45, fixedrange=True) +fig.update_layout(height=400 * rows, title_text="SHAP explanations") +fig.show() + +``` + +Your results will look like: + + diff --git a/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Text Explainers.md b/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Text Explainers.md new file mode 100644 index 0000000000..2de87b5fec --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/responsible_ai/Interpretability - Text Explainers.md @@ -0,0 +1,135 @@ +--- +title: Interpretability - Text Explainers +hide_title: true +status: stable +--- +## Interpretability - Text Explainers + +In this example, we use LIME and Kernel SHAP explainers to explain a text classification model. + +First we import the packages and define some UDFs and a plotting function we will need later. + + +``` +from pyspark.sql.functions import * +from pyspark.sql.types import * +from pyspark.ml.feature import StopWordsRemover, HashingTF, IDF, Tokenizer +from pyspark.ml import Pipeline +from pyspark.ml.classification import LogisticRegression +from synapse.ml.explainers import * +from synapse.ml.featurize.text import TextFeaturizer + +vec2array = udf(lambda vec: vec.toArray().tolist(), ArrayType(FloatType())) +vec_access = udf(lambda v, i: float(v[i]), FloatType()) +``` + +Load training data, and convert rating to binary label. + + +``` +data = ( + spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/BookReviewsFromAmazon10K.parquet") + .withColumn("label", (col("rating") > 3).cast(LongType())) + .select("label", "text") + .cache() +) + +display(data) +``` + +We train a text classification model, and randomly sample 10 rows to explain. + + +``` +train, test = data.randomSplit([0.60, 0.40]) + +pipeline = Pipeline( + stages=[ + TextFeaturizer( + inputCol="text", + outputCol="features", + useStopWordsRemover=True, + useIDF=True, + minDocFreq=20, + numFeatures=1 << 16, + ), + LogisticRegression(maxIter=100, regParam=0.005, labelCol="label", featuresCol="features"), + ] +) + +model = pipeline.fit(train) + +prediction = model.transform(test) + +explain_instances = prediction.orderBy(rand()).limit(10) +``` + + +``` +def plotConfusionMatrix(df, label, prediction, classLabels): + from synapse.ml.plot import confusionMatrix + import matplotlib.pyplot as plt + + fig = plt.figure(figsize=(4.5, 4.5)) + confusionMatrix(df, label, prediction, classLabels) + display(fig) + + +plotConfusionMatrix(model.transform(test), "label", "prediction", [0, 1]) +``` + +First we use the LIME text explainer to explain the model's predicted probability for a given observation. + + +``` +lime = TextLIME( + model=model, + outputCol="weights", + inputCol="text", + targetCol="probability", + targetClasses=[1], + tokensCol="tokens", + samplingFraction=0.7, + numSamples=2000, +) + +lime_results = ( + lime.transform(explain_instances) + .select("tokens", "weights", "r2", "probability", "text") + .withColumn("probability", vec_access("probability", lit(1))) + .withColumn("weights", vec2array(col("weights").getItem(0))) + .withColumn("r2", vec_access("r2", lit(0))) + .withColumn("tokens_weights", arrays_zip("tokens", "weights")) +) + +display(lime_results.select("probability", "r2", "tokens_weights", "text").orderBy(col("probability").desc())) +``` + +Then we use the Kernel SHAP text explainer to explain the model's predicted probability for a given observation. + +> Notice that we drop the base value from the SHAP output before displaying the SHAP values. The base value is the model output for an empty string. + + +``` +shap = TextSHAP( + model=model, + outputCol="shaps", + inputCol="text", + targetCol="probability", + targetClasses=[1], + tokensCol="tokens", + numSamples=5000, +) + +shap_results = ( + shap.transform(explain_instances) + .select("tokens", "shaps", "r2", "probability", "text") + .withColumn("probability", vec_access("probability", lit(1))) + .withColumn("shaps", vec2array(col("shaps").getItem(0))) + .withColumn("shaps", slice(col("shaps"), lit(2), size(col("shaps")))) + .withColumn("r2", vec_access("r2", lit(0))) + .withColumn("tokens_shaps", arrays_zip("tokens", "shaps")) +) + +display(shap_results.select("probability", "r2", "tokens_shaps", "text").orderBy(col("probability").desc())) +``` diff --git a/website/versioned_docs/version-0.9.5/features/responsible_ai/Model Interpretation on Spark.md b/website/versioned_docs/version-0.9.5/features/responsible_ai/Model Interpretation on Spark.md new file mode 100644 index 0000000000..d2c7cc5f4e --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/responsible_ai/Model Interpretation on Spark.md @@ -0,0 +1,174 @@ +--- +title: Model Interpretation on Spark +hide_title: true +sidebar_label: Model Interpretation on Spark +--- + +# Model Interpretation on Spark + +## Interpretable Machine Learning + +Interpretable Machine Learning helps developers, data scientists and business stakeholders in the organization gain a comprehensive understanding of their machine learning models. It can also be used to debug models, explain predictions and enable auditing to meet compliance with regulatory requirements. + +## Why run model interpretation on Spark + +Model-agnostic interpretation methods can be computationally expensive due to the multiple evaluations needed to compute the explanations. Model interpretation on Spark enables users to interpret a black-box model at massive scales with the Apache Spark™ distributed computing ecosystem. Various components support local interpretation for tabular, vector, image and text classification models, with two popular model-agnostic interpretation methods: [LIME] and [Kernel SHAP]. + +[LIME]: https://arxiv.org/abs/1602.04938 + +[Kernel SHAP]: https://arxiv.org/abs/1705.07874 + +## Usage + +Both LIME and Kernel SHAP are local interpretation methods. Local interpretation explains why does the model predict certain outcome for a given observation. + +Both explainers extends from `org.apache.spark.ml.Transformer`. After setting up the explainer parameters, simply call the `transform` function on a `DataFrame` of observations to interpret the model behavior on these observations. + +To see examples of model interpretability on Spark in action, take a look at these sample notebooks: + +- [Tabular SHAP explainer](../../../features/responsible_ai/Interpretability%20-%20Tabular%20SHAP%20explainer) +- [Image explainers](../../../features/responsible_ai/Interpretability%20-%20Image%20Explainers) +- [Text explainers](../../../features/responsible_ai/Interpretability%20-%20Text%20Explainers) + +| | Tabular models | Vector models | Image models | Text models | +|------------------------|-----------------------------|---------------------------|-------------------------|-----------------------| +| LIME explainers | [TabularLIME](#tabularlime) | [VectorLIME](#vectorlime) | [ImageLIME](#imagelime) | [TextLIME](#textlime) | +| Kernel SHAP explainers | [TabularSHAP](#tabularshap) | [VectorSHAP](#vectorshap) | [ImageSHAP](#imageshap) | [TextSHAP](#textshap) | + +### Common local explainer params + +All local explainers support the following params: + +| Param | Type | Default | Description | +|------------------|---------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| targetCol | `String` | "probability" | The column name of the prediction target to explain (i.e. the response variable). This is usually set to "prediction" for regression models and "probability" for probabilistic classification models. | +| targetClasses | `Array[Int]` | empty array | The indices of the classes for multinomial classification models. | +| targetClassesCol | `String` | | The name of the column that specifies the indices of the classes for multinomial classification models. | +| outputCol | `String` | | The name of the output column for interpretation results. | +| model | `Transformer` | | The model to be explained. | + +### Common LIME explainer params + +All LIME based explainers ([TabularLIME](#tabularlime), [VectorLIME](#vectorlime), [ImageLIME](#imagelime), [TextLIME](#textlime)) support the following params: + +| Param | Type | Default | Description | +|----------------|----------|---------------------------------|-----------------------------------------------------------| +| regularization | `Double` | 0 | Regularization param for the underlying lasso regression. | +| kernelWidth | `Double` | sqrt(number of features) * 0.75 | Kernel width for the exponential kernel. | +| numSamples | `Int` | 1000 | Number of samples to generate. | +| metricsCol | `String` | "r2" | Column name for fitting metrics. | + +### Common SHAP explainer params + +All Kernel SHAP based explainers ([TabularSHAP](#tabularshap), [VectorSHAP](#vectorshap), [ImageSHAP](#imageshap), [TextSHAP](#textshap)) support the following params: + +| Param | Type | Default | Description | +|------------|----------|---------------------------------|------------------------------------------------| +| infWeight | `Double` | 1E8 | The double value to represent infinite weight. | +| numSamples | `Int` | 2 * (number of features) + 2048 | Number of samples to generate. | +| metricsCol | `String` | "r2" | Column name for fitting metrics. | + +### Tabular model explainer params + +All tabular model explainers ([TabularLIME](#tabularlime), [TabularSHAP](#tabularshap)) support the following params: + +| Param | Type | Default | Description | +|----------------|-----------------|---------|--------------------------------------------------------------------------------------------------------------| +| inputCols | `Array[String]` | | The names of input columns to the black-box model. | +| backgroundData | `DataFrame` | | A dataframe containing background data. It must contain all the input columns needed by the black-box model. | + +### Vector model explainer params + +All vector model explainers ([VectorLIME](#vectorlime), [VectorSHAP](#vectorshap)) support the following params: + +| Param | Type | Default | Description | +|----------------|-------------|---------|----------------------------------------------------------------------------------------------------------------| +| inputCol | `String` | | The names of input vector column to the black-box model. | +| backgroundData | `DataFrame` | | A dataframe containing background data. It must contain the input vector column needed by the black-box model. | + +### Image model explainer params + +All image model explainers ([ImageLIME](#imagelime), [ImageSHAP](#imageshap)) support the following params: + +| Param | Type | Default | Description | +|---------------|----------|---------------|--------------------------------------------------------------------| +| inputCol | `String` | | The names of input image column to the black-box model. | +| cellSize | `Double` | 16 | Number that controls the size of the super-pixels. | +| modifier | `Double` | 130 | Controls the trade-off spatial and color distance of super-pixels. | +| superpixelCol | `String` | "superpixels" | The column holding the super-pixel decompositions. | + +### Text model explainer params + +All text model explainers ([TextLIME](#textlime), [TextSHAP](#textshap)) support the following params: + +| Param | Type | Default | Description | +|-----------|----------|----------|--------------------------------------------------------| +| inputCol | `String` | | The names of input text column to the black-box model. | +| tokensCol | `String` | "tokens" | The column holding the text tokens. | + +### `TabularLIME` + +| Param | Type | Default | Description | +|---------------------|-----------------|-------------|----------------------------------------------------------------------| +| categoricalFeatures | `Array[String]` | empty array | The name of columns that should be treated as categorical variables. | + +> For categorical features, `TabularLIME` creates new samples by drawing samples based on the value distribution from the background dataset. For numerical features, it creates new samples by drawing from a normal distribution with mean taken from the target value to be explained, and standard deviation taken from the background dataset. + +### `TabularSHAP` + +No additional params are supported. + +### `VectorLIME` + +No additional params are supported. + +> `VectorLIME` assumes all features are numerical, and categorical features are not supported in `VectorLIME`. + +### `VectorSHAP` + +No additional params are supported. + +### `ImageLIME` + +| Param | Type | Default | Description | +|------------------|----------|---------|----------------------------------------------------------| +| samplingFraction | `Double` | 0.7 | The fraction of super-pixels to keep on during sampling. | + +> `ImageLIME` creates new samples by randomly turning super-pixels on or off with probability of keeping on set to `SamplingFraction`. + +### `ImageSHAP` + +No additional params are supported. + +### `TextLIME` + +| Param | Type | Default | Description | +|------------------|----------|---------|---------------------------------------------------------| +| samplingFraction | `Double` | 0.7 | The fraction of word tokens to keep on during sampling. | + +> `TextLIME` creates new samples by randomly turning word tokens on or off with probability of keeping on set to `SamplingFraction`. + +### `TextSHAP` + +No additional params are supported. + +## Result interpretation + +### LIME explainers + +LIME explainers return an array of vectors, and each vector maps to a class being explained. Each component of the vector is the coefficient for the corresponding feature, super-pixel, or word token from the local surrogate model. + +- For categorical variables, super-pixels, or word tokens, the coefficient shows the average change in model outcome if this feature is unknown to the model, if the super-pixel is replaced with background color (black), or if the word token is replaced with empty string. +- For numeric variables, the coefficient shows the change in model outcome if the feature value is incremented by 1 unit. + +### SHAP explainers + +SHAP explainers return an array of vectors, and each vector maps to a class being explained. Each vector starts with the [base value](#base-value), and each following component of the vector is the Shapley value for each feature, super-pixel, or token. + +The base value and Shapley values are additive, and they should add up to the model output for the target observation. + +#### Base value + +- For tabular and vector models, the base value represents the mean outcome of the model for the background dataset. +- For image models, the base value represents the model outcome for a background (all black) image. +- For text models, the base value represents the model outcome for an empty string. diff --git a/website/versioned_docs/version-0.9.5/features/spark_serving/SparkServing - Deploying a Classifier.md b/website/versioned_docs/version-0.9.5/features/spark_serving/SparkServing - Deploying a Classifier.md new file mode 100644 index 0000000000..7115b08a81 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/spark_serving/SparkServing - Deploying a Classifier.md @@ -0,0 +1,120 @@ +--- +title: SparkServing - Deploying a Classifier +hide_title: true +status: stable +--- +## Model Deployment with Spark Serving +In this example, we try to predict incomes from the *Adult Census* dataset. Then we will use Spark serving to deploy it as a realtime web service. +First, we import needed packages: + + +```python +import os +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() +``` + + +```python +import sys +import numpy as np +import pandas as pd + +``` + +Now let's read the data and split it to train and test sets: + + +```python +data = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/AdultCensusIncome.parquet") +data = data.select(["education", "marital-status", "hours-per-week", "income"]) +train, test = data.randomSplit([0.75, 0.25], seed=123) +train.limit(10).toPandas() +``` + +`TrainClassifier` can be used to initialize and fit a model, it wraps SparkML classifiers. +You can use `help(synapse.ml.TrainClassifier)` to view the different parameters. + +Note that it implicitly converts the data into the format expected by the algorithm. More specifically it: + tokenizes, hashes strings, one-hot encodes categorical variables, assembles the features into a vector +etc. The parameter `numFeatures` controls the number of hashed features. + + +```python +from synapse.ml.train import TrainClassifier +from pyspark.ml.classification import LogisticRegression +model = TrainClassifier(model=LogisticRegression(), labelCol="income", numFeatures=256).fit(train) +``` + +After the model is trained, we score it against the test dataset and view metrics. + + +```python +from synapse.ml.train import ComputeModelStatistics, TrainedClassifierModel +prediction = model.transform(test) +prediction.printSchema() +``` + + +```python +metrics = ComputeModelStatistics().transform(prediction) +metrics.limit(10).toPandas() +``` + +First, we will define the webservice input/output. +For more information, you can visit the [documentation for Spark Serving](https://github.com/Microsoft/SynapseML/blob/master/docs/mmlspark-serving.md) + + +```python +from pyspark.sql.types import * +from synapse.ml.io import * +import uuid + +serving_inputs = spark.readStream.server() \ + .address("localhost", 8898, "my_api") \ + .option("name", "my_api") \ + .load() \ + .parseRequest("my_api", test.schema) + +serving_outputs = model.transform(serving_inputs) \ + .makeReply("prediction") + +server = serving_outputs.writeStream \ + .server() \ + .replyTo("my_api") \ + .queryName("my_query") \ + .option("checkpointLocation", "file:///tmp/checkpoints-{}".format(uuid.uuid1())) \ + .start() + +``` + +Test the webservice + + +```python +import requests +data = u'{"education":" 10th","marital-status":"Divorced","hours-per-week":40.0}' +r = requests.post(data=data, url="http://localhost:8898/my_api") +print("Response {}".format(r.text)) +``` + + +```python +import requests +data = u'{"education":" Masters","marital-status":"Married-civ-spouse","hours-per-week":40.0}' +r = requests.post(data=data, url="http://localhost:8898/my_api") +print("Response {}".format(r.text)) +``` + + +```python +import time +time.sleep(20) # wait for server to finish setting up (just to be safe) +server.stop() +``` + + +```python + +``` diff --git a/website/versioned_docs/version-0.9.5/features/spark_serving/about.md b/website/versioned_docs/version-0.9.5/features/spark_serving/about.md new file mode 100644 index 0000000000..1881e1b9c4 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/spark_serving/about.md @@ -0,0 +1,227 @@ +--- +title: Spark Serving +hide_title: true +sidebar_label: About +--- + + + +# Spark Serving + +### An Engine for Deploying Spark Jobs as Distributed Web Services + +- **Distributed**: Takes full advantage of Node, JVM, and thread level + parallelism that Spark is famous for. +- **Fast**: No single node bottlenecks, no round trips to Python. + Requests can be routed directly to and from worker JVMs through + network switches. Spin up a web service in a matter of seconds. +- **Low Latency**: When using continuous serving, + you can achieve latencies as low as 1 millisecond. +- **Deployable Anywhere**: Works anywhere that runs Spark such as + Databricks, HDInsight, AZTK, DSVMs, local, or on your own + cluster. Usable from Spark, PySpark, and SparklyR. +- **Lightweight**: No dependence on additional (costly) Kafka or + Kubernetes clusters. +- **Idiomatic**: Uses the same API as batch and structured streaming. +- **Flexible**: Spin up and manage several services on a single Spark + cluster. Synchronous and Asynchronous service management and + extensibility. Deploy any spark job that is expressible as a + structured streaming query. Use serving sources/sinks with other + Spark data sources/sinks for more complex deployments. + +## Usage + +### Jupyter Notebook Examples + +- [Deploy a classifier trained on the Adult Census Dataset](../SparkServing%20-%20Deploying%20a%20Classifier) +- More coming soon! + +### Spark Serving Hello World + +```python +import synapse.ml +import pyspark +from pyspark.sql.functions import udf, col, length +from pyspark.sql.types import * + +df = spark.readStream.server() \ + .address("localhost", 8888, "my_api") \ + .load() \ + .parseRequest(StructType().add("foo", StringType()).add("bar", IntegerType())) + +replies = df.withColumn("fooLength", length(col("foo")))\ + .makeReply("fooLength") + +server = replies\ + .writeStream \ + .server() \ + .replyTo("my_api") \ + .queryName("my_query") \ + .option("checkpointLocation", "file:///path/to/checkpoints") \ + .start() +``` + +### Deploying a Deep Network with the CNTKModel + +```python +import synapse.ml +from synapse.ml.cntk import CNTKModel +import pyspark +from pyspark.sql.functions import udf, col + +df = spark.readStream.server() \ + .address("localhost", 8888, "my_api") + .load() + .parseRequest() + +# See notebook examples for how to create and save several +# examples of CNTK models +network = CNTKModel.load("file:///path/to/my_cntkmodel.mml") + +transformed_df = network.transform(df).makeReply() + +server = transformed_df \ + .writeStream \ + .server() \ + .replyTo("my_api") \ + .queryName("my_query") \ + .option("checkpointLocation", "file:///path/to/checkpoints") \ + .start() +``` + +## Architecture + +Spark Serving adds special streaming sources sinks to turn any +structured streaming job into a web service. Spark Serving comes +with two deployment options that vary based on the load balancing used: + +In brief you can use the following: +`spark.readStream.server()`: For head node load balanced services +`spark.readStream.distributedServer()`: For custom load balanced services +`spark.readStream.continuousServer()`: For a custom load balanced, sub-millisecond latency continuous server + +To create the various different serving dataframes and use the equivalent statements after `df.writeStream` +for replying to the web requests + +### Head Node Load Balanced + +You can deploy head node load balancing with the `HTTPSource` and +`HTTPSink` classes. This mode spins up a queue on the head node, +distributes work across partitions, then collects response data back to +the head node. All HTTP requests are kept and replied to on the head +node. In both python and Scala these classes can be access by using +`spark.readStream.server()` after importing SynapseML. +This mode allows for more complex windowing, repartitioning, and +SQL operations. This option is also idea for rapid setup and testing, +as it doesn't require any additional load balancing or network +switches.A diagram of this configuration can be seen below: + +

+ +

+ +### Fully Distributed (Custom Load Balancer) + +You can configure Spark Serving for a custom load balancer using the +`DistributedHTTPSource` and `DistributedHTTPSink` classes. This mode +spins up servers on each executor JVM. +In both python and Scala these classes can be access by using +`spark.readStream.distributedServer()` after importing SynapseML. +Each server will feed its +executor's partitions in parallel. This mode is key for high throughput +and low latency as data does not need to be transferred to and from the +head node. This deployment results in several web services that all +route into the same spark computation. You can deploy an external load +balancer to unify the executor's services under a single IP address. +Support for automatic load balancer management and deployment is +targeted for the next release of SynapseML. A diagram of this +configuration can be seen below: + +

+ +

+ +Queries that involve data movement across workers, such as a nontrivial +SQL join, need special consideration. The user must ensure that the +right machine replies to each request. One can route data back to the +originating partition with a broadcast join. In the future, request +routing will be automatically handled by the sink. + +### Sub-Millisecond Latency with Continuous Processing + +

+ +

+ +Continuous processing can be enabled by hooking into the `HTTPSourceV2` class using: + + spark.readStream.continuousServer() + ... + +Note that in continuous serving, much like continuous streaming you need to add a trigger to your write statement: + + df.writeStream + .continuousServer() + .trigger(continuous="1 second") + ... + +The architecture is very similiar to the custom load balancer setup described above. +More specifically, Spark will manage a web service on each partition. +These webservices can be unified together using an Azure Load Balancer, +Kubernetes Service Endpoint, Azure Application gateway or any other way to load balance a distributed service. +It is currently the user's responsibility to optionally unify these services as they see fit. +In the furutre we will include options to dynamically spin up and manage a load balancer. + +#### Databricks Setup + +Databricks is a managed architecture and they have restricted +all incoming traffic to the nodes of the cluster. +If you create a web service in your databricks cluster (head or worker nodes), +your cluster can communicate with the service, but the outside world cannot. +However, In the future, Databricks will support Virtual Network Injection so this will not be a problem. +In the meantime, you must use SSH tunneling to forward the services to another machine(s) +to act as a networking gateway. This machine can be any machine that accpets SSH traffic and requests. +We have included settings to automatically configure this SSH tunneling for convenience. + +##### Linux Gateway Setup - Azure + +1. [Create a Linux VM using SSH](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/quick-create-portal) +2. [Open ports 8000-9999 from the Azure Portal](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/nsg-quickstart-portal) +3. Open the port on the firewall on the VM + ```$xslt + firewall-cmd --zone=public --add-port=8000-10000/tcp --permanent + firewall-cmd --reload + echo "GatewayPorts yes" >> /etc/ssh/sshd_config + service ssh --full-restart + ``` +4. Add your private key to a private container in [Azure Storage Blob](https://docs.microsoft.com/en-us/azure/storage/common/storage-quickstart-create-account?toc=%2Fazure%2Fstorage%2Fblobs%2Ftoc.json&tabs=portal). +5. Generate a SAS link for your key and save it. +6. Simply include the following parameters on your reader to configure the SSH tunneling: + serving_inputs = (spark.readStream.continuousServer() + .option("numPartitions", 1) + .option("forwarding.enabled", True) # enable ssh forwarding to a gateway machine + .option("forwarding.username", "username") + .option("forwarding.sshHost", "ip or dns") + .option("forwarding.keySas", "SAS url from the previous step") + .address("localhost", 8904, "my_api") + .load() + +Note that this will make your service require an extra jump and affect latency. +It is important to pick a gateway that has good connectivity to your spark cluster. +For this reason we suggest using Spark Serving +on a cluster enviromnent that is more open such as Kubernetes, Mesos, or Azure Batch +for best performance and ease of configuration. + +## Parameters + +| Parameter Name | Description | Necessary | Default Value | Applicable When | +| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------- | ----------------------------------------------------------------------------------------------------- | +| host | The host to spin up a server on | Yes | | | +| port | The starting port when creating the web services. Web services will increment this port several times to find an open port. In the future the flexibility of this param will be expanded | yes | | | +| name | The Path of the api a user would call. The format is `hostname:port/name` | yes | | | +| forwarding.enabled | Whether to forward the services to a gateway machine | no | false | When you need to forward services out of a protected network. Only Supported for Continuous Serving. | +| forwarding.username | the username to connect to on the remote host | no | | | +| forwarding.sshport | the port to ssh connect to | no | 22 | | +| forwarding.sshHost | the host of the gateway machine | no | | | +| forwarding.keySas | A Secure access link that can be used to automatically download the required ssh private key | no | | Sometimes more convenient than a directory | +| forwarding.keyDir | A directory on the machines holding the private key | no | "~/.ssh" | Useful if you cannot send keys over the wire securely | diff --git a/website/versioned_docs/version-0.9.5/features/vw/Vowpal Wabbit - Overview.md b/website/versioned_docs/version-0.9.5/features/vw/Vowpal Wabbit - Overview.md new file mode 100644 index 0000000000..ee48672341 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/vw/Vowpal Wabbit - Overview.md @@ -0,0 +1,481 @@ +--- +title: Vowpal Wabbit - Overview +hide_title: true +status: stable +--- + + +# VowalWabbit + +[VowpalWabbit](https://github.com/VowpalWabbit/vowpal_wabbit) (VW) is a machine learning system which +pushes the frontier of machine learning with techniques such as online, hashing, allreduce, +reductions, learning2search, active, and interactive learning. +VowpalWabbit is a popular choice in ad-tech due to it's speed and cost efficacy. +Furthermore it includes many advances in the area of reinforcement learning (e.g. contextual bandits). + +### Advantages of VowpalWabbit + +- **Composability**: VowpalWabbit models can be incorporated into existing + SparkML Pipelines, and used for batch, streaming, and serving workloads. +- **Small footprint**: VowpalWabbit memory consumption is rather small and can be controlled through '-b 18' or setNumBits method. + This determines the size of the model (e.g. 2^18 * some_constant). +- **Feature Interactions**: Feature interactions (e.g. quadratic, cubic,... terms) are created on-the-fly within the most inner + learning loop in VW. + Interactions can be specified by using the -q parameter and passing the first character of the namespaces that should be _interacted_. + The VW namespace concept is mapped to Spark using columns. The column name is used as namespace name, thus one sparse or dense Spark ML vector corresponds to the features of a single namespace. + To allow passing of multiple namespaces the VW estimator (classifier or regression) expose an additional property called _additionalFeatures_. Users can pass an array of column names. +- **Simple deployment**: all native dependencies are packaged into a single jars (including boost and zlib). +- **VowpalWabbit command line arguments**: users can pass VW command line arguments to control the learning process. +- **VowpalWabbit binary models** Users can supply an inital VowpalWabbit model to start the training which can be produced outside of + VW on Spark by invoking _setInitialModel_ and pass the model as a byte array. Similarly users can access the binary model by invoking + _getModel_ on the trained model object. +- **Java-based hashing** VWs version of murmur-hash was re-implemented in Java (praise to [JackDoe](https://github.com/jackdoe)) + providing a major performance improvement compared to passing input strings through JNI and hashing in C++. +- **Cross language** VowpalWabbit on Spark is available on Spark, PySpark, and SparklyR. + +### Limitations of VowpalWabbit on Spark + +- **Linux and CentOS only** The native binaries included with the published jar are built Linux and CentOS only. + We're working on creating a more portable version by statically linking Boost and lib C++. +- **Limited Parsing** Features implemented in the native VW parser (e.g. ngrams, skips, ...) are not yet implemented in + VowpalWabbitFeaturizer. + +### VowpalWabbit Usage: + +- VowpalWabbitClassifier: used to build classification models. +- VowpalWabbitRegressor: used to build regression models. +- VowpalWabbitFeaturizer: used for feature hashing and extraction. For details please visit [here](https://github.com/VowpalWabbit/vowpal_wabbit/wiki/Feature-Hashing-and-Extraction). +- VowpalWabbitContextualBandit: used to solve contextual bandits problems. For algorithm details please visit [here](https://github.com/VowpalWabbit/vowpal_wabbit/wiki/Contextual-Bandit-algorithms). + +## Heart Disease Detection with VowalWabbit Classifier + + + +#### Read dataset + + +```python +import os + +if os.environ.get("AZURE_SERVICE", None) == "Microsoft.ProjectArcadia": + from pyspark.sql import SparkSession + spark = SparkSession.builder.getOrCreate() +``` + + +```python +df = spark.read.format("csv")\ + .option("header", True)\ + .option("inferSchema", True)\ + .load("wasbs://publicwasb@mmlspark.blob.core.windows.net/heart_disease_prediction_data.csv") +# print dataset basic info +print("records read: " + str(df.count())) +print("Schema: ") +df.printSchema() +``` + + +```python +display(df) +``` + +#### Split the dataset into train and test + + +```python +train, test = df.randomSplit([0.85, 0.15], seed=1) +``` + +#### Use VowalWabbitFeaturizer to convert data features into vector + + +```python +from synapse.ml.vw import VowpalWabbitFeaturizer +featurizer = VowpalWabbitFeaturizer(inputCols=df.columns[:-1], outputCol="features") +train_data = featurizer.transform(train)["target", "features"] +test_data = featurizer.transform(test)["target", "features"] +``` + + +```python +display(train_data.groupBy("target").count()) +``` + +#### Model Training + + +```python +from synapse.ml.vw import VowpalWabbitClassifier +model = VowpalWabbitClassifier(numPasses=20, labelCol="target", featuresCol="features").fit(train_data) +``` + +#### Model Prediction + + +```python +predictions = model.transform(test_data) +display(predictions) +``` + + +```python +from synapse.ml.train import ComputeModelStatistics +metrics = ComputeModelStatistics(evaluationMetric='classification', labelCol='target', scoredLabelsCol='prediction').transform(predictions) +display(metrics) +``` + +## Adult Census with VowpalWabbitClassifier + +In this example, we predict incomes from the Adult Census dataset using Vowpal Wabbit (VW) Classifier in SynapseML. + +#### Read dataset and split them into train & test + + +```python +data = spark.read.parquet("wasbs://publicwasb@mmlspark.blob.core.windows.net/AdultCensusIncome.parquet") +data = data.select(["education", "marital-status", "hours-per-week", "income"]) +train, test = data.randomSplit([0.75, 0.25], seed=123) +display(train) +``` + +#### Model Training + +We define a pipeline that includes feature engineering and training of a VW classifier. We use a featurizer provided by VW that hashes the feature names. Note that VW expects classification labels being -1 or 1. Thus, the income category is mapped to this space before feeding training data into the pipeline. + +Note: VW supports distributed learning, and it's controlled by number of partitions of dataset. + + +```python +from pyspark.sql.functions import when, col +from pyspark.ml import Pipeline +from synapse.ml.vw import VowpalWabbitFeaturizer, VowpalWabbitClassifier + +# Define classification label +train = train.withColumn("label", when(col("income").contains("<"), 0.0).otherwise(1.0)).repartition(1) +print(train.count()) + +# Specify featurizer +vw_featurizer = VowpalWabbitFeaturizer(inputCols=["education", "marital-status", "hours-per-week"], + outputCol="features") +``` + +Note: "args" parameter lets you pass in any params not exposed through our API. Full command line argument docs can be found [here](https://github.com/VowpalWabbit/vowpal_wabbit/wiki/Command-Line-Arguments). + + +```python +# Define VW classification model +args = "--loss_function=logistic --quiet --holdout_off" +vw_model = VowpalWabbitClassifier(featuresCol="features", + labelCol="label", + args=args, + numPasses=10) + +# Create a pipeline +vw_pipeline = Pipeline(stages=[vw_featurizer, vw_model]) +``` + + +```python +vw_trained = vw_pipeline.fit(train) +``` + +#### Model Prediction + +After the model is trained, we apply it to predict the income of each sample in the test set. + + +```python +# Making predictions +test = test.withColumn("label", when(col("income").contains("<"), 0.0).otherwise(1.0)) +prediction = vw_trained.transform(test) +display(prediction) +``` + +Finally, we evaluate the model performance using ComputeModelStatistics function which will compute confusion matrix, accuracy, precision, recall, and AUC by default for classificaiton models. + + +```python +from synapse.ml.train import ComputeModelStatistics +metrics = ComputeModelStatistics(evaluationMetric="classification", + labelCol="label", + scoredLabelsCol="prediction").transform(prediction) +display(metrics) +``` + +## Boston house price prediction with VowpalWabbitRegressor - Quantile Regression + +In this example, we show how to build regression model with VW using Boston's house price. + +#### Read dataset + +We use [*Boston house price* dataset](https://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_boston.html) +. +The data was collected in 1978 from Boston area and consists of 506 entries with 14 features including the value of homes. +We use `sklearn.datasets` module to download it easily, then split the set into training and testing by 75/25. + + +```python +import math +from matplotlib.colors import ListedColormap, Normalize +from matplotlib.cm import get_cmap +import matplotlib.pyplot as plt +from synapse.ml.train import ComputeModelStatistics +from synapse.ml.vw import VowpalWabbitRegressor, VowpalWabbitFeaturizer +import numpy as np +import pandas as pd +from sklearn.datasets import load_boston +``` + + +```python +boston = load_boston() + +feature_cols = ['f' + str(i) for i in range(boston.data.shape[1])] +header = ['target'] + feature_cols +df = spark.createDataFrame( + pd.DataFrame(data=np.column_stack((boston.target, boston.data)), columns=header) +).repartition(1) +print("Dataframe has {} rows".format(df.count())) +display(df.limit(10)) +``` + + +```python +train_data, test_data = df.randomSplit([0.75, 0.25], seed=42) +``` + + +```python +display(train_data.summary().toPandas()) +``` + + +```python +train_data.show(10) +``` + +Exploratory analysis: plot feature distributions over different target values. + + +```python +features = train_data.columns[1:] +values = train_data.drop('target').toPandas() +ncols = 5 +nrows = math.ceil(len(features) / ncols) + +yy = [r['target'] for r in train_data.select('target').collect()] + +f, axes = plt.subplots(nrows, ncols, sharey=True, figsize=(30,10)) +f.tight_layout() + +for irow in range(nrows): + axes[irow][0].set_ylabel('target') + for icol in range(ncols): + try: + feat = features[irow*ncols + icol] + xx = values[feat] + + axes[irow][icol].scatter(xx, yy, s=10, alpha=0.25) + axes[irow][icol].set_xlabel(feat) + axes[irow][icol].get_yaxis().set_ticks([]) + except IndexError: + f.delaxes(axes[irow][icol]) +``` + +#### VW-style feature hashing + + +```python +vw_featurizer = VowpalWabbitFeaturizer( + inputCols=feature_cols, + outputCol='features', +) +vw_train_data = vw_featurizer.transform(train_data)['target', 'features'] +vw_test_data = vw_featurizer.transform(test_data)['target', 'features'] +display(vw_train_data) +``` + +#### Model training & Prediction + +See [VW wiki](https://github.com/vowpalWabbit/vowpal_wabbit/wiki/Command-Line-Arguments) for command line arguments. + + +```python +args = "--holdout_off --loss_function quantile -l 7 -q :: --power_t 0.7" +vwr = VowpalWabbitRegressor( + labelCol='target', + featuresCol='features', + args=args, + numPasses=200, +) + +# To reduce number of partitions (which will effect performance), use `vw_train_data.repartition(1)` +vw_model = vwr.fit(vw_train_data.repartition(1)) +vw_predictions = vw_model.transform(vw_test_data) + +display(vw_predictions.limit(20).toPandas()) +``` + +#### Compute Statistics & Visualization + + +```python +metrics = ComputeModelStatistics( + evaluationMetric='regression', + labelCol='target', + scoresCol='prediction' +).transform(vw_predictions) + +vw_result = metrics.toPandas() +vw_result.insert(0, 'model', ['Vowpal Wabbit']) +display(vw_result) +``` + + +```python +cmap = get_cmap('YlOrRd') +target = np.array(test_data.select('target').collect()).flatten() +model_preds = [("Vowpal Wabbit", vw_predictions)] + +f, axe = plt.subplots(figsize=(6, 6)) +f.tight_layout() + +preds = np.array(vw_predictions.select('prediction').collect()).flatten() +err = np.absolute(preds - target) +norm = Normalize() +clrs = cmap(np.asarray(norm(err)))[:, :-1] +plt.scatter(preds, target, s=60, c=clrs, edgecolors='#888888', alpha=0.75) +plt.plot((0, 60), (0, 60), linestyle='--', color='#888888') +axe.set_xlabel('Predicted values') +axe.set_ylabel('Actual values') +axe.set_title("Vowpal Wabbit") +``` + +## Quantile Regression for Drug Discovery with VowpalWabbitRegressor + + + +#### Read dataset + + +```python +triazines = spark.read.format("libsvm")\ + .load("wasbs://publicwasb@mmlspark.blob.core.windows.net/triazines.scale.svmlight") +``` + + +```python +# print some basic info +print("records read: " + str(triazines.count())) +print("Schema: ") +triazines.printSchema() +display(triazines.limit(10)) +``` + +#### Split dataset into train and test + + +```python +train, test = triazines.randomSplit([0.85, 0.15], seed=1) +``` + +#### Model Training + + +```python +from synapse.ml.vw import VowpalWabbitRegressor +model = (VowpalWabbitRegressor(numPasses=20, args="--holdout_off --loss_function quantile -q :: -l 0.1") + .fit(train)) +``` + +#### Model Prediction + + +```python +scoredData = model.transform(test) +display(scoredData.limit(10)) +``` + + +```python +from synapse.ml.train import ComputeModelStatistics +metrics = ComputeModelStatistics(evaluationMetric='regression', + labelCol='label', + scoresCol='prediction') \ + .transform(scoredData) +display(metrics) +``` + +## VW Contextual Bandit + +#### Read dataset + + +```python +data = spark.read.format("json").load("wasbs://publicwasb@mmlspark.blob.core.windows.net/vwcb_input.dsjson") +``` + +Note: Actions are all five TAction_x_topic columns. + + +```python +from pyspark.sql.functions import col +from pyspark.sql.types import IntegerType, DoubleType +data = data.withColumn('GUser_id', col('c.GUser.id'))\ + .withColumn('GUser_major', col('c.GUser.major'))\ + .withColumn('GUser_hobby', col('c.GUser.hobby'))\ + .withColumn('GUser_favorite_character', col('c.GUser.favorite_character'))\ + .withColumn('TAction_0_topic', col('c._multi.TAction.topic')[0])\ + .withColumn('TAction_1_topic', col('c._multi.TAction.topic')[1])\ + .withColumn('TAction_2_topic', col('c._multi.TAction.topic')[2])\ + .withColumn('TAction_3_topic', col('c._multi.TAction.topic')[3])\ + .withColumn('TAction_4_topic', col('c._multi.TAction.topic')[4])\ + .withColumn('chosenAction', col('_label_Action').cast(IntegerType()))\ + .withColumn('label', col('_labelIndex').cast(DoubleType()))\ + .withColumn('probability', col('_label_probability'))\ + .select('GUser_id', 'GUser_major', 'GUser_hobby', 'GUser_favorite_character', 'TAction_0_topic', 'TAction_1_topic', 'TAction_2_topic', 'TAction_3_topic', 'TAction_4_topic', 'chosenAction', 'label', 'probability') + +print("Schema: ") +data.printSchema() +``` + +Add pipeline to add featurizer, convert all feature columns into vector. + + +```python +from synapse.ml.vw import VowpalWabbitFeaturizer, VowpalWabbitContextualBandit, VectorZipper +from pyspark.ml import Pipeline +pipeline = Pipeline(stages=[ + VowpalWabbitFeaturizer(inputCols=['GUser_id'], outputCol='GUser_id_feature'), + VowpalWabbitFeaturizer(inputCols=['GUser_major'], outputCol='GUser_major_feature'), + VowpalWabbitFeaturizer(inputCols=['GUser_hobby'], outputCol='GUser_hobby_feature'), + VowpalWabbitFeaturizer(inputCols=['GUser_favorite_character'], outputCol='GUser_favorite_character_feature'), + VowpalWabbitFeaturizer(inputCols=['TAction_0_topic'], outputCol='TAction_0_topic_feature'), + VowpalWabbitFeaturizer(inputCols=['TAction_1_topic'], outputCol='TAction_1_topic_feature'), + VowpalWabbitFeaturizer(inputCols=['TAction_2_topic'], outputCol='TAction_2_topic_feature'), + VowpalWabbitFeaturizer(inputCols=['TAction_3_topic'], outputCol='TAction_3_topic_feature'), + VowpalWabbitFeaturizer(inputCols=['TAction_4_topic'], outputCol='TAction_4_topic_feature'), + VectorZipper(inputCols=['TAction_0_topic_feature', 'TAction_1_topic_feature', 'TAction_2_topic_feature', 'TAction_3_topic_feature','TAction_4_topic_feature'], outputCol='features') +]) +tranformation_pipeline = pipeline.fit(data) +transformed_data = tranformation_pipeline.transform(data) + +display(transformed_data) +``` + +Build VowpalWabbit Contextual Bandit model and compute performance statistics. + + +```python +estimator = VowpalWabbitContextualBandit() \ + .setArgs("--cb_explore_adf --epsilon 0.2 --quiet") \ + .setSharedCol('GUser_id_feature') \ + .setAdditionalSharedFeatures(["GUser_major_feature", "GUser_hobby_feature", "GUser_favorite_character_feature"]) \ + .setFeaturesCol('features') \ + .setUseBarrierExecutionMode(False)\ + .setChosenActionCol('chosenAction')\ + .setLabelCol('label')\ + .setProbabilityCol('probability') +model = estimator.fit(transformed_data) +display(model.getPerformanceStatistics()) +``` diff --git a/website/versioned_docs/version-0.9.5/features/vw/about.md b/website/versioned_docs/version-0.9.5/features/vw/about.md new file mode 100644 index 0000000000..292145e498 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/features/vw/about.md @@ -0,0 +1,113 @@ +--- +title: VW +hide_title: true +sidebar_label: About +--- + + + +# VowpalWabbit on Apache Spark + +### Overview + +[VowpalWabbit](https://github.com/VowpalWabbit/vowpal_wabbit) (VW) is a machine learning system which +pushes the frontier of machine learning with techniques such as online, hashing, allreduce, +reductions, learning2search, active, and interactive learning. +VowpalWabbit is a popular choice in ad-tech due to it's speed and cost efficacy. +Furthermore it includes many advances in the area of reinforcement learning (e.g. contextual bandits). + +### Advantages of VowpalWabbit + +- **Composability**: VowpalWabbit models can be incorporated into existing + SparkML Pipelines, and used for batch, streaming, and serving workloads. +- **Small footprint**: VowpalWabbit memory consumption is rather small and can be controlled through '-b 18' or setNumBits method. + This determines the size of the model (e.g. 2^18 * some_constant). +- **Feature Interactions**: Feature interactions (e.g. quadratic, cubic,... terms) are created on-the-fly within the most inner + learning loop in VW. + Interactions can be specified by using the -q parameter and passing the first character of the namespaces that should be _interacted_. + The VW namespace concept is mapped to Spark using columns. The column name is used as namespace name, thus one sparse or dense Spark ML vector corresponds to the features of a single namespace. + To allow passing of multiple namespaces the VW estimator (classifier or regression) expose an additional property called _additionalFeatures_. Users can pass an array of column names. +- **Simple deployment**: all native dependencies are packaged into a single jars (including boost and zlib). +- **VowpalWabbit command line arguments**: users can pass VW command line arguments to control the learning process. +- **VowpalWabbit binary models** Users can supply an inital VowpalWabbit model to start the training which can be produced outside of + VW on Spark by invoking _setInitialModel_ and pass the model as a byte array. Similarly users can access the binary model by invoking + _getModel_ on the trained model object. +- **Java-based hashing** VWs version of murmur-hash was re-implemented in Java (praise to [JackDoe](https://github.com/jackdoe)) + providing a major performance improvement compared to passing input strings through JNI and hashing in C++. +- **Cross language** VowpalWabbit on Spark is available on Spark, PySpark, and SparklyR. + +### Limitations of VowpalWabbit on Spark + +- **Linux and CentOS only** The native binaries included with the published jar are built Linux and CentOS only. + We're working on creating a more portable version by statically linking Boost and lib C++. +- **Limited Parsing** Features implemented in the native VW parser (e.g. ngrams, skips, ...) are not yet implemented in + VowpalWabbitFeaturizer. + +### Usage + +In PySpark, you can run the `VowpalWabbitClassifier` via: + +```python +from synapse.ml.vw import VowpalWabbitClassifier +model = (VowpalWabbitClassifier(numPasses=5, args="--holdout_off --loss_function logistic") + .fit(train)) +``` + +Similarly, you can run the `VowpalWabbitRegressor`: + +```python +from synapse.ml.vw import VowpalWabbitRegressor +model = (VowpalWabbitRegressor(args="--holdout_off --loss_function quantile -q :: -l 0.1") + .fit(train)) +``` + +Through the args parameter you can pass command line parameters to VW as documented in the [VW Wiki](https://github.com/vowpalWabbit/vowpal_wabbit/wiki/Command-Line-Arguments). + +For an end to end application, check out the VowpalWabbit [notebook +example](../Vowpal%20Wabbit%20-%20Overview). + +### Hyper-parameter tuning + +- Common parameters can also be set through methods enabling the use of SparkMLs ParamGridBuilder and CrossValidator ([example](https://github.com/Azure/mmlspark/blob/master/src/test/scala/com/microsoft/azure/synapse/ml/vw/VerifyVowpalWabbitClassifier.scala#L29)). Note if + the same parameters are passed through _args_ property (e.g. args="-l 0.2" and setLearningRate(0.5)) the _args_ value will + take precedence. + parameter +* learningRate +* numPasses +* numBits +* l1 +* l2 +* powerT +* interactions +* ignoreNamespaces + +### Architecture + +VowpalWabbit on Spark uses an optimized JNI layer to efficiently support Spark. +Java bindings can be found in the [VW GitHub repo](https://github.com/VowpalWabbit/vowpal_wabbit/blob/master/java/src/main/c%2B%2B/jni_spark_vw_generated.h). + +VWs command line tool uses a 2-thread architecture (1x parsing/hashing, 1x learning) for learning and inference. +To fluently embed VW into the Spark ML eco system the following adaptions were made: + +- VW classifier/regressor operates on Spark's dense/sparse vectors + - Pro: best composability with existing Spark ML components. + - Cons: due to type restrictions (e.g. feature indicies are Java integers) the maximum model size is limited to 30-bits. One could overcome this restriction by adding additional type support to the classifier/regressor to directly operate on input features (e.g. strings, int, double, ...). + +- VW hashing is separated out into the [VowpalWabbitFeaturizer](https://github.com/Azure/mmlspark/blob/master/src/test/scala/com/microsoft/azure/synapse/ml/vw/VerifyVowpalWabbitFeaturizer.scala#L34) transformer. It supports mapping Spark Dataframe schema into VWs namespaces and sparse +features. + - Pro: featurization can be scaled to many nodes, scale independent of distributed learning. + - Pro: hashed features can be cached and efficiently re-used when performing hyper-parameter sweeps. + - Pro: featurization can be used for other Spark ML learning algorithms. + - Cons: due to type restrictions (e.g. sparse indicies are Java integers) the hash space is limited by 30-bits. + +- VW multi-pass training can be enabled using '--passes 4' argument or setNumPasses method. Cache file is automatically named. + - Pro: simplified usage. + - Pro: certain algorithms (e.g. l-bfgs) require a cache file when running in multi-pass node. + - Cons: The cache file is created in the Java temp directory. Depending on your nodes i/o and the location of the temp directory this can be a bottleneck. +- VW distributed training is transparently setup and can be controlled through the input dataframes number of partitions. + Similar to LightGBM all training instances must be running at the same time, thus the maxium parallelism is restricted by the + number of executors available in the cluster. Under the hoods VWs built-in spanning tree functionality is used to coordinate allreduce. + Required parameters are automatically determined and supplied to VW. The spanning tree coordination process is run on the driver node. + - Pro: seamless parallelization. + - Cons: currently barrier execution mode is not implemented and thus if one node crashes the complete job needs to be manually restarted. + diff --git a/website/versioned_docs/version-0.9.5/getting_started/first_example.md b/website/versioned_docs/version-0.9.5/getting_started/first_example.md new file mode 100644 index 0000000000..fb582002d9 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/getting_started/first_example.md @@ -0,0 +1,66 @@ +--- +title: First Example +description: Build machine learning applications using Microsoft Machine Learning for Apache Spark +--- + +## Prerequisites + +- If you don't have an Azure subscription, [create a free account before you begin](https://azure.microsoft.com/free/). +- [Azure Synapse Analytics workspace](https://docs.microsoft.com/en-us/azure/synapse-analytics/get-started-create-workspace) with an Azure Data Lake Storage Gen2 storage account configured as the default storage. You need to be the _Storage Blob Data Contributor_ of the Data Lake Storage Gen2 file system that you work with. +- Spark pool in your Azure Synapse Analytics workspace. For details, see [Create a Spark pool in Azure Synapse](https://docs.microsoft.com/en-us/azure/synapse-analytics/get-started-analyze-spark). +- Pre-configuration steps described in the tutorial [Configure Cognitive Services in Azure Synapse](https://docs.microsoft.com/en-us/azure/synapse-analytics/machine-learning/tutorial-configure-cognitive-services-synapse). + +## Get started + +To get started, import synapse.ml and configurate service keys. + +```python +import synapse.ml +from synapse.ml.cognitive import * +from notebookutils import mssparkutils + +# A general Cognitive Services key for Text Analytics and Computer Vision (or use separate keys that belong to each service) +cognitive_service_key = mssparkutils.credentials.getSecret("ADD_YOUR_KEY_VAULT_NAME", "ADD_YOUR_SERVICE_KEY","ADD_YOUR_KEY_VAULT_LINKED_SERVICE_NAME") +# A Bing Search v7 subscription key +bingsearch_service_key = mssparkutils.credentials.getSecret("ADD_YOUR_KEY_VAULT_NAME", "ADD_YOUR_BING_SEARCH_KEY","ADD_YOUR_KEY_VAULT_LINKED_SERVICE_NAME") +# An Anomaly Dectector subscription key +anomalydetector_key = mssparkutils.credentials.getSecret("ADD_YOUR_KEY_VAULT_NAME", "ADD_YOUR_ANOMALY_KEY","ADD_YOUR_KEY_VAULT_LINKED_SERVICE_NAME") + + +``` + +## Text analytics sample + +The [Text Analytics](https://azure.microsoft.com/en-us/services/cognitive-services/text-analytics/) service provides several algorithms for extracting intelligent insights from text. For example, we can find the sentiment of given input text. The service will return a score between 0.0 and 1.0 where low scores indicate negative sentiment and high score indicates positive sentiment. This sample uses three simple sentences and returns the sentiment for each. + +```python +from pyspark.sql.functions import col + +# Create a dataframe that's tied to it's column names +df_sentences = spark.createDataFrame([ + ("I am so happy today, its sunny!", "en-US"), + ("this is a dog", "en-US"),s + ("I am frustrated by this rush hour traffic!", "en-US") +], ["text", "language"]) + +# Run the Text Analytics service with options +sentiment = (TextSentiment() + .setTextCol("text") + .setLocation("eastasia") # Set the location of your cognitive service + .setSubscriptionKey(cognitive_service_key) + .setOutputCol("sentiment") + .setErrorCol("error") + .setLanguageCol("language")) + +# Show the results of your text query in a table format + +display(sentiment.transform(df_sentences).select("text", col("sentiment")[0].getItem("sentiment").alias("sentiment"))) +``` + +### Expected results + +| text | sentiment | +| ------------------------------------------ | --------- | +| I am frustrated by this rush hour traffic! | negative | +| this is a dog | neutral | +| I am so happy today, its sunny! | positive | diff --git a/website/versioned_docs/version-0.9.5/getting_started/first_model.md b/website/versioned_docs/version-0.9.5/getting_started/first_model.md new file mode 100644 index 0000000000..c84668a128 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/getting_started/first_model.md @@ -0,0 +1,117 @@ +--- +title: First Model +hide_title: true +description: First Model +--- + +# Your First Model + +In this example, we construct a basic classification model to predict a person's +income level given demographics data such as education level or marital status. +We also learn how to use Jupyter notebooks for developing and running the model. + +### Prerequisites + +- You have installed the SynapseML package, either as a Docker image or on a + Spark cluster, +- You have basic knowledge of Python language, +- You have basic understanding of machine learning concepts: training, testing, + classification. + +### Working with Jupyter Notebooks + +Once you have the SynapseML package installed, open Jupyter notebooks folder in +your web browser + +- Local Docker: `http://localhost:8888` +- Spark cluster: `https:///jupyter` + +Create a new notebook by selecting "New" -> "PySpark3". Let's also give the +notebook a friendlier name, _Adult Census Income Prediction_, by clicking the +title. + +### Importing Packages and Starting the Spark Application + +At this point, the notebook is not yet running a Spark application. In the +first cell, let's import some needed packages + +```python +import numpy as np +import pandas as pd +``` + +Click the "run cell" button on the toolbar to start the application. After a +few moments, you should see the message "SparkSession available as 'spark'". +Now you're ready to start coding and running your application. + +### Reading in Data + +In a typical Spark application, you'd likely work with huge datasets stored on +distributed file system, such as HDFS. However, to keep this tutorial simple +and quick, we'll copy over a small dataset from a URL. We then read this data +into memory using Pandas CSV reader, and distribute the data as a Spark +DataFrame. Finally, we show the first 5 rows of the dataset. Copy the following +code to the next cell in your notebook, and run the cell. + +```python +dataFile = "AdultCensusIncome.csv" +import os, urllib +if not os.path.isfile(dataFile): + urllib.request.urlretrieve("https://mmlspark.azureedge.net/datasets/" + dataFile, dataFile) +data = spark.createDataFrame(pd.read_csv(dataFile, dtype={" hours-per-week": np.float64})) +data.show(5) +``` + +### Selecting Features and Splitting Data to Train and Test Sets + +Next, select some features to use in our model. You can try out different +features, but you should include `" income"` as it is the label column the model +is trying to predict. We then split the data into a `train` and `test` sets. + +```python +data = data.select([" education", " marital-status", " hours-per-week", " income"]) +train, test = data.randomSplit([0.75, 0.25], seed=123) +``` + +### Training a Model + +To train the classifier model, we use the `synapse.ml.TrainClassifier` class. It +takes in training data and a base SparkML classifier, maps the data into the +format expected by the base classifier algorithm, and fits a model. + +```python +from synapse.ml.train import TrainClassifier +from pyspark.ml.classification import LogisticRegression +model = TrainClassifier(model=LogisticRegression(), labelCol=" income").fit(train) +``` + +Note that `TrainClassifier` implicitly handles string-valued columns and +binarizes the label column. + +### Scoring and Evaluating the Model + +Finally, let's score the model against the test set, and use +`synapse.ml.ComputeModelStatistics` class to compute metrics — accuracy, AUC, +precision, recall — from the scored data. + +```python +from synapse.ml.train import ComputeModelStatistics +prediction = model.transform(test) +metrics = ComputeModelStatistics().transform(prediction) +metrics.select('accuracy').show() +``` + +And that's it: you've build your first machine learning model using the SynapseML +package. For help on SynapseML classes and methods, you can use Python's help() +function, for example + +```python +help(synapse.ml.train.TrainClassifier) +``` + +Next, view our other tutorials to learn how to + +- Tune model parameters to find the best model +- Use SparkML pipelines to build a more complex model +- Use deep neural networks for image classification +- Use text analytics for document classification diff --git a/website/versioned_docs/version-0.9.5/getting_started/installation.md b/website/versioned_docs/version-0.9.5/getting_started/installation.md new file mode 100644 index 0000000000..5117936a6d --- /dev/null +++ b/website/versioned_docs/version-0.9.5/getting_started/installation.md @@ -0,0 +1,128 @@ +--- +title: Installation +description: Getting started with SynapseML +--- + +### Python + +To try out SynapseML on a Python (or Conda) installation you can get Spark +installed via pip with `pip install pyspark`. You can then use `pyspark` as in +the above example, or from python: + +```python +import pyspark +spark = pyspark.sql.SparkSession.builder.appName("MyApp") \ + .config("spark.jars.packages", "com.microsoft.azure:synapseml_2.12:0.9.5") \ + .config("spark.jars.repositories", "https://mmlspark.azureedge.net/maven") \ + .getOrCreate() +import synapse.ml +``` + +### SBT + +If you are building a Spark application in Scala, add the following lines to +your `build.sbt`: + +```scala +resolvers += "SynapseML" at "https://mmlspark.azureedge.net/maven" +libraryDependencies += "com.microsoft.azure" %% "synapseml" % "0.9.5" + +``` + +### Spark package + +SynapseML can be conveniently installed on existing Spark clusters via the +`--packages` option, examples: + +```bash +spark-shell --packages com.microsoft.azure:synapseml_2.12:0.9.5 +pyspark --packages com.microsoft.azure:synapseml_2.12:0.9.5 +spark-submit --packages com.microsoft.azure:synapseml_2.12:0.9.5 MyApp.jar +``` + +This can be used in other Spark contexts too. For example, you can use SynapseML +in [AZTK](https://github.com/Azure/aztk/) by [adding it to the +`.aztk/spark-defaults.conf` +file](https://github.com/Azure/aztk/wiki/PySpark-on-Azure-with-AZTK#optional-set-up-mmlspark). + +### Databricks + +To install SynapseML on the [Databricks +cloud](http://community.cloud.databricks.com), create a new [library from Maven +coordinates](https://docs.databricks.com/user-guide/libraries.html#libraries-from-maven-pypi-or-spark-packages) +in your workspace. + +For the coordinates use: `com.microsoft.azure:synapseml_2.12:0.9.5` +with the resolver: `https://mmlspark.azureedge.net/maven`. Ensure this library is +attached to your target cluster(s). + +Finally, ensure that your Spark cluster has at least Spark 3.12 and Scala 2.12. + +You can use SynapseML in both your Scala and PySpark notebooks. To get started with our example notebooks import the following databricks archive: + +`https://mmlspark.blob.core.windows.net/dbcs/SynapseMLExamplesv0.9.5.dbc` + +### Apache Livy and HDInsight + +To install SynapseML from within a Jupyter notebook served by Apache Livy the following configure magic can be used. You will need to start a new session after this configure cell is executed. + +Excluding certain packages from the library may be necessary due to current issues with Livy 0.5 + +``` +%%configure -f +{ + "name": "synapseml", + "conf": { + "spark.jars.packages": "com.microsoft.azure:synapseml_2.12:0.9.5", + "spark.jars.excludes": "org.scala-lang:scala-reflect,org.apache.spark:spark-tags_2.12,org.scalactic:scalactic_2.12,org.scalatest:scalatest_2.12" + } +} +``` + +In Azure Synapse, "spark.yarn.user.classpath.first" should be set to "true" to override the existing SynapseML packages + +``` +%%configure -f +{ + "name": "synapseml", + "conf": { + "spark.jars.packages": "com.microsoft.azure:synapseml_2.12:0.9.5", + "spark.jars.excludes": "org.scala-lang:scala-reflect,org.apache.spark:spark-tags_2.12,org.scalactic:scalactic_2.12,org.scalatest:scalatest_2.12", + "spark.yarn.user.classpath.first": "true" + } +} +``` + +### Docker + +The easiest way to evaluate SynapseML is via our pre-built Docker container. To +do so, run the following command: + +```bash +docker run -it -p 8888:8888 -e ACCEPT_EULA=yes mcr.microsoft.com/mmlspark/release +``` + +Navigate to in your web browser to run the sample +notebooks. See the [documentation](reference/docker.md) for more on Docker use. + +> To read the EULA for using the docker image, run +``` bash +docker run -it -p 8888:8888 mcr.microsoft.com/mmlspark/release eula +``` + + +### Building from source + +SynapseML has recently transitioned to a new build infrastructure. +For detailed developer docs please see the [Developer Readme](reference/developer-readme.md) + +If you are an existing SynapseML developer, you will need to reconfigure your +development setup. We now support platform independent development and +better integrate with intellij and SBT. + If you encounter issues please reach out to our support email! + +### R (Beta) + +To try out SynapseML using the R autogenerated wrappers [see our +instructions](reference/R-setup.md). Note: This feature is still under development +and some necessary custom wrappers may be missing. diff --git a/website/versioned_docs/version-0.9.5/reference/R-setup.md b/website/versioned_docs/version-0.9.5/reference/R-setup.md new file mode 100644 index 0000000000..60976bbf98 --- /dev/null +++ b/website/versioned_docs/version-0.9.5/reference/R-setup.md @@ -0,0 +1,120 @@ +--- +title: R setup +hide_title: true +sidebar_label: R setup +description: R setup and example for SynapseML +--- + + +# R setup and example for SynapseML + +## Installation + +**Requirements**: You will need to have R and +[devtools](https://github.com/hadley/devtools) installed on your +machine. + +To install the current SynapseML package for R use: + +```R +... +devtools::install_url("https://mmlspark.azureedge.net/rrr/synapseml-0.9.5.zip") +... +``` + +### Importing libraries and setting up spark context + +It will take some time to install all dependencies. Then, run: + +```R +... +library(sparklyr) +library(dplyr) +config <- spark_config() +config$sparklyr.defaultPackages <- "com.microsoft.azure:synapseml_2.12:0.9.5" +sc <- spark_connect(master = "local", config = config) +... +``` + +This will create a spark context on local machine. + +We will then need to import the R wrappers: + +```R +... +library(synapseml) +... +``` + +## Example + +We can use the faithful dataset in R: + +```R +... +faithful_df <- copy_to(sc, faithful) +cmd_model = ml_clean_missing_data( + x=faithful_df, + inputCols = c("eruptions", "waiting"), + outputCols = c("eruptions_output", "waiting_output"), + only.model=TRUE) +sdf_transform(cmd_model, faithful_df) +... +``` + +You should see the output: + +```R +... +# Source: table [?? x 4] +# Database: spark_connection + eruptions waiting eruptions_output waiting_output + + 1 3.600 79 3.600 79 + 2 1.800 54 1.800 54 + 3 3.333 74 3.333 74 + 4 2.283 62 2.283 62 + 5 4.533 85 4.533 85 + 6 2.883 55 2.883 55 + 7 4.700 88 4.700 88 + 8 3.600 85 3.600 85 + 9 1.950 51 1.950 51 + 10 4.350 85 4.350 85 + # ... with more rows +... +``` + +## Azure Databricks + +In Azure Databricks, you can install devtools and the spark package from URL +and then use spark_connect with method = "databricks": + +```R +install.packages("devtools") +devtools::install_url("https://mmlspark.azureedge.net/rrr/synapseml-0.9.5.zip") +library(sparklyr) +library(dplyr) +sc <- spark_connect(method = "databricks") +faithful_df <- copy_to(sc, faithful) +unfit_model = ml_light_gbmregressor(sc, maxDepth=20, featuresCol="waiting", labelCol="eruptions", numIterations=10, unfit.model=TRUE) +ml_train_regressor(faithful_df, labelCol="eruptions", unfit_model) +``` + +## Building from Source + +Our R bindings are built as part of the [normal build +process](developer-readme.md). To get a quick build, start at the root +of the synapsemldirectory, and: + +```bash +./runme TESTS=NONE +unzip ./BuildArtifacts/packages/R/synapseml-0.0.zip +``` + +You can then run R in a terminal and install the above files directly: + +```R +... +devtools::install_local("./BuildArtifacts/packages/R/synapseml") +... +``` diff --git a/website/versioned_docs/version-0.9.5/reference/SAR.md b/website/versioned_docs/version-0.9.5/reference/SAR.md new file mode 100644 index 0000000000..d9aac2c21f --- /dev/null +++ b/website/versioned_docs/version-0.9.5/reference/SAR.md @@ -0,0 +1,183 @@ +--- +title: Smart Adaptive Recommendations (SAR) Algorithm +hide_title: true +sidebar_label: SAR Algorithm +--- + + +# Smart Adaptive Recommendations (SAR) Algorithm + +The following document is a subset of the implemented logic, the orginal can be found [here](https://github.com/Microsoft/Product-Recommendations/blob/master/doc/sar.md) + +**SAR** is a fast scalable adaptive algorithm for personalized recommendations based on user transactions history and items description. It produces easily explainable / interpretable recommendations. + +The overall architecture of SAR is shown in the following diagram: + +![SAR Diagram](https://i.imgur.com/AMPShWl.jpg) + +## Input + +The input to SAR consists of: + +- transaction (usage) data +- catalog data + +**Transaction data**, also called **usage data**, contains information on interactions between users and items and has the following schema: + +`,,