Skip to content

Commit 903dc6b

Browse files
authored
docs: move cognitive namespace to services namespace (#2118)
* docs: move cognitive namespace to services namespace * add deprecation warnings
1 parent fd00b87 commit 903dc6b

21 files changed

Lines changed: 117 additions & 94 deletions

cognitive/src/main/scala/com/microsoft/azure/synapse/ml/services/anomaly/AnomalyDetection.scala

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,12 @@ abstract class AnomalyDetectorBase(override val uid: String) extends CognitiveSe
145145
}
146146
}
147147

148+
@deprecated("The Anomaly Detection Service will be shutting down in 2026," +
149+
" please use IsolationForest for anomaly detection", "v1.0.0")
148150
object DetectLastAnomaly extends ComplexParamsReadable[DetectLastAnomaly] with Serializable
149151

152+
@deprecated("The Anomaly Detection Service will be shutting down in 2026," +
153+
" please use IsolationForest for anomaly detection", "v1.0.0")
150154
class DetectLastAnomaly(override val uid: String) extends AnomalyDetectorBase(uid) with SynapseMLLogging {
151155
logClass(FeatureNames.AiServices.Anomaly)
152156

@@ -162,8 +166,12 @@ class DetectLastAnomaly(override val uid: String) extends AnomalyDetectorBase(ui
162166

163167
}
164168

169+
@deprecated("The Anomaly Detection Service will be shutting down in 2026," +
170+
" please use IsolationForest for anomaly detection", "v1.0.0")
165171
object DetectAnomalies extends ComplexParamsReadable[DetectAnomalies] with Serializable
166172

173+
@deprecated("The Anomaly Detection Service will be shutting down in 2026," +
174+
" please use IsolationForest for anomaly detection", "v1.0.0")
167175
class DetectAnomalies(override val uid: String) extends AnomalyDetectorBase(uid) with SynapseMLLogging {
168176
logClass(FeatureNames.AiServices.Anomaly)
169177

@@ -179,8 +187,12 @@ class DetectAnomalies(override val uid: String) extends AnomalyDetectorBase(uid)
179187

180188
}
181189

190+
@deprecated("The Anomaly Detection Service will be shutting down in 2026," +
191+
" please use IsolationForest for anomaly detection", "v1.0.0")
182192
object SimpleDetectAnomalies extends ComplexParamsReadable[SimpleDetectAnomalies] with Serializable
183193

194+
@deprecated("The Anomaly Detection Service will be shutting down in 2026," +
195+
" please use IsolationForest for anomaly detection", "v1.0.0")
184196
class SimpleDetectAnomalies(override val uid: String) extends AnomalyDetectorBase(uid)
185197
with HasOutputCol with SynapseMLLogging {
186198
logClass(FeatureNames.AiServices.Anomaly)

cognitive/src/main/scala/com/microsoft/azure/synapse/ml/services/anomaly/MultivariateAnomalyDetection.scala

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -412,8 +412,12 @@ trait MADBase extends HasOutputCol with TimeConverter
412412

413413
}
414414

415+
@deprecated("The Anomaly Detection Service will be shutting down in 2026," +
416+
" please use IsolationForest for anomaly detection", "v1.0.0")
415417
object SimpleFitMultivariateAnomaly extends ComplexParamsReadable[SimpleFitMultivariateAnomaly] with Serializable
416418

419+
@deprecated("The Anomaly Detection Service will be shutting down in 2026," +
420+
" please use IsolationForest for anomaly detection", "v1.0.0")
417421
class SimpleFitMultivariateAnomaly(override val uid: String) extends Estimator[SimpleDetectMultivariateAnomaly]
418422
with MADBase {
419423
logClass(FeatureNames.AiServices.Anomaly)
@@ -565,8 +569,12 @@ trait DetectMAParams extends Params {
565569
setDefault(topContributorCount -> 10)
566570
}
567571

572+
@deprecated("The Anomaly Detection Service will be shutting down in 2026," +
573+
" please use IsolationForest for anomaly detection", "v1.0.0")
568574
object SimpleDetectMultivariateAnomaly extends ComplexParamsReadable[SimpleDetectMultivariateAnomaly] with Serializable
569575

576+
@deprecated("The Anomaly Detection Service will be shutting down in 2026," +
577+
" please use IsolationForest for anomaly detection", "v1.0.0")
570578
class SimpleDetectMultivariateAnomaly(override val uid: String) extends Model[SimpleDetectMultivariateAnomaly]
571579
with MADBase with HasHandler with DetectMAParams {
572580
logClass(FeatureNames.AiServices.Anomaly)
@@ -647,8 +655,12 @@ class SimpleDetectMultivariateAnomaly(override val uid: String) extends Model[Si
647655

648656
}
649657

658+
@deprecated("The Anomaly Detection Service will be shutting down in 2026," +
659+
" please use IsolationForest for anomaly detection", "v1.0.0")
650660
object DetectLastMultivariateAnomaly extends ComplexParamsReadable[DetectLastMultivariateAnomaly] with Serializable
651661

662+
@deprecated("The Anomaly Detection Service will be shutting down in 2026," +
663+
" please use IsolationForest for anomaly detection", "v1.0.0")
652664
class DetectLastMultivariateAnomaly(override val uid: String) extends CognitiveServicesBase(uid)
653665
with HasInternalJsonOutputParser with TimeConverter with HasTimestampCol
654666
with HasSetLocation with HasCognitiveServiceInput with HasBatchSize

docs/Explore Algorithms/AI Services/Advanced Usage - Async, Batching, and Multi-Key.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
}
1313
},
1414
"source": [
15-
"# Cognitive Services Advanced Guide: Asynchrony, Batching, Multi-Key"
15+
"# AI Services Advanced Guide: Asynchrony, Batching, Multi-Key"
1616
]
1717
},
1818
{
@@ -98,7 +98,7 @@
9898
},
9999
"outputs": [],
100100
"source": [
101-
"from synapse.ml.cognitive.vision import AnalyzeImage\n",
101+
"from synapse.ml.services.vision import AnalyzeImage\n",
102102
"\n",
103103
"# Create a dataframe with the image URLs\n",
104104
"base_url = \"https://raw.githubusercontent.com/Azure-Samples/cognitive-services-sample-data-files/master/ComputerVision/Images/\"\n",
@@ -301,7 +301,7 @@
301301
},
302302
"outputs": [],
303303
"source": [
304-
"from synapse.ml.cognitive.text import TextSentiment\n",
304+
"from synapse.ml.services.text import TextSentiment\n",
305305
"\n",
306306
"# Create a dataframe\n",
307307
"text_df = spark.createDataFrame(\n",
@@ -356,7 +356,7 @@
356356
},
357357
"outputs": [],
358358
"source": [
359-
"from synapse.ml.cognitive.text import TextSentiment\n",
359+
"from synapse.ml.services.text import TextSentiment\n",
360360
"from pyspark.sql.functions import udf\n",
361361
"import random\n",
362362
"\n",
@@ -418,7 +418,7 @@
418418
"notebookMetadata": {
419419
"pythonIndentUnit": 2
420420
},
421-
"notebookName": "CognitiveServices - Advanced Usage: Async, Batching, and Multi-Key",
421+
"notebookName": "AI Services - Advanced Usage: Async, Batching, and Multi-Key",
422422
"notebookOrigID": 3743502060540796,
423423
"widgets": {}
424424
},

docs/Explore Algorithms/AI Services/Geospatial Services.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
"metadata": {},
7878
"outputs": [],
7979
"source": [
80-
"from synapse.ml.cognitive import *\n",
80+
"from synapse.ml.services import *\n",
8181
"from synapse.ml.services.geospatial import *\n",
8282
"from synapse.ml.core.platform import *\n",
8383
"\n",

docs/Explore Algorithms/AI Services/Multivariate Anomaly Detection.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@
128128
"import matplotlib.pyplot as plt\n",
129129
"\n",
130130
"import synapse.ml\n",
131-
"from synapse.ml.cognitive import *"
131+
"from synapse.ml.services.anomaly import *"
132132
]
133133
},
134134
{

0 commit comments

Comments
 (0)