updated notes for changes made between 3.19.21 and 3.23.21

Author: jyaistMap

guide/02-api-overview/release-notes.ipynb

@@ -88,13 +88,20 @@
     "#### [`arcgis.learn`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html)\n",
     "* New Table of Contents heading:\n",
     "  * Replace [`Tabular and Feature Models`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#tabular-and-feature-data-models) with [`Feature, Tabular and Timeseries Models`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#feature-tabular-and-timeseries-models)\n",
-    "* New models:\n",
+    "* New Table of Contents entry and models:\n",
     "  * [`Object Tracking Models`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#object-tracking-models)\n",
     "    * [`SiamMask`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#siammask)\n",
     "    * [`ObjectTracker`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#objecttracker)\n",
     "    * [`Track`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#tracker)\n",
-    "* Adds cell size ranges and output units to trainied models (`Esri Model Definitions`)\n",
+    "* Adds cell size ranges and output units to trained models (`Esri Model Definitions`)\n",
     "* Adds `monitor` parameter to `fit()` methods of models for use with `early_stopping` and `checkpoint`\n",
+    "* Adds documentation to `path` parameter for [`prepare_data()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#prepare-data)\n",
+    "* Adds keyword parameters and documentation to [`prepare_data()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#prepare-data):\n",
+    "  * `min_points`\n",
+    "  * `classes_of_interest`\n",
+    "  * `extra_features`\n",
+    "  * `remap_classes`\n",
+    "  * `background_classcode`\n",
     "* [`Data Preparation Methods`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#data-preparation-methods)\n",
     "  * Adds ability to use a folder or list of paths (multi-folder support) in `path` parameter for [`prepare_data()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#prepare-data)\n",
     "  * Adds `working_dir` parameter to data prepartion methods which sets a default path as a prefix for saving trained models and checkpoints\n",
@@ -119,11 +126,13 @@
     "    * Adds cabability to [`save()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#arcgis.learn.MLModel.save) method to allow saving model without data input\n",
     "  * [`TimeSeriesModel`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#timeseriesmodel)\n",
     "    * Enhances vizualization to show separate graph for each dependent variable when using `show_batch()` on `TabularData` object\n",
+    "    * Adds warning message when using [`predict()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#arcgis.learn.TimeSeriesModel.predict) if  [`openpyxl`](https://openpyxl.readthedocs.io/en/stable/) dependency not installed\n",
     "* [`Pixel Classification Models`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#pixel-classification-models)\n",
     " * Adds [`ConnectNet`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#connectnet) Model\n",
-    "  * Adds inference and exports support to:\n",
+    " * Adds `dice_loss_average` keyword parameter to initialization options\n",
+    " * Adds inference and exports support to:\n",
     "    * [`ChangeDetector`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#changedetector)\n",
-    "  * Adds threshholding functionality to:\n",
+    " * Adds threshholding functionality to:\n",
     "    * [`BDCNEdgeDetector`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=retinanet#bdcnedgedetector)\n",
     "    * [`HEDEdgeDectector`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=retinanet#hededgedetector)\n",
     "  * [`MultiTaskRoadExtractor`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=retinanet#multitaskroadextractor)\n",
@@ -133,6 +142,9 @@
     "  * Adds inference and export support to:\n",
     "    * [`Pix2Pix`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#pix2pix)\n",
     "    * [`CycleGAN`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#cyclegan)\n",
+    "  * Adds additional checks for whether multispectral images were used in initialization for:\n",
+    "    * [`Pix2Pix`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#pix2pix)\n",
+    "    * [`CycleGAN`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#cyclegan)\n",
     "* [`Model Management`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#model-management)\n",
     " * Adds [`train_model()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#train-model) method"
    ]
@@ -207,15 +219,22 @@
    "metadata": {},
    "source": [
     "#### [`arcgis.learn`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html)\n",
+    "* Fixes to various functions and model methods for `ArcGIS Pro Notebooks`\n",
+    "  * `show_batch()` \n",
+    "  * `lr_find()` \n",
+    "  * `model.show_results()`\n",
+    "* Fixes `WARNING 003054: Input Raster does not support PIXEL_SPACE (raw image space). Running in MAP_SPACE` warning message when running the [Classify Pixels Using Deep Learning](https://pro.arcgis.com/en/pro-app/latest/tool-reference/image-analyst/classify-pixels-using-deep-learning.htm) tool in `ArcGIS Pro`\n",
     "* [`Data Preparation Methods`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#data-preparation-methods)\n",
     "  * Fixes `expected scalar type Float` Exception with [`prepare_data()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#prepare-data) when using `pytorch 1.7.0`\n",
     "* [`Pixel Classification Models`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#pixel-classification-models)\n",
+    "  * Improves `per_class_metrics()` results on models initialized from unbalanced datasets\n",
     "  * Fixes `fit()` method in segmentation models returning `NaN` values for certain attributes: [`UNetClassifier`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#unetclassifier), [`PSPNetClassifier`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#pspnetclassifier), [`DeepLab`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#deeplab)\n",
     "  * [`MultiTaskRoadExtractor`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=retinanet#multitaskroadextractor) \n",
     "   * Fixes issue for [`show_results()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=retinanet#arcgis.learn.MultiTaskRoadExtractor.show_results) plotting images incorrectly\n",
     "   * Fixes issue causing [`save()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=retinanet#arcgis.learn.MultiTaskRoadExtractor.save) only to work after calling [`fit()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=retinanet#arcgis.learn.MultiTaskRoadExtractor.fit)\n",
     "   * Fixes [`load()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=retinanet#arcgis.learn.MultiTaskRoadExtractor.load) so it only needs the model name\n",
     "   * Fixes errors with [`fit()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=retinanet#arcgis.learn.MultiTaskRoadExtractor.fit) when using monitor functionality\n",
+    "   * Fixes parameter table for [`show_results()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#arcgis.learn.MultiTaskRoadExtractor.show_results) documentation\n",
     "* [`Unstructured Text Models`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#unstructured-text-models)\n",
     "  * [`arcgis.learn.text`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#arcgis-learn-text-module) module\n",
     "    * Adds capability to use `HuggingFace` [pretrained models](https://huggingface.co/transformers/pretrained_models.html) for:\n",
@@ -237,8 +256,7 @@
     "    * Fixes issue with [`lr_find()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=tabulardata#arcgis.learn.FeatureClassifier.lr_find):\n",
     "      * with object created with [`mixup=True`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=tabulardata#arcgis.learn.FeatureClassifier)\n",
     "      * with `MultiLabeled_Tiles` dataset type object and [`mixup=True`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=tabulardata#arcgis.learn.FeatureClassifier)\n",
-    "    * Fixes issue with using [`predict()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=tabulardata#arcgis.learn.FeatureClassifier.predict) on a trained model\n",
-    "    \n",
+    "    * Fixes issue with using [`predict()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html?highlight=tabulardata#arcgis.learn.FeatureClassifier.predict) on a trained model    \n",
     "* [`Feature, Tabular and Timeseries Models`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#feature-tabular-and-timeseries-models)\n",
     "  * [`MLModel`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#mlmodel)\n",
     "    * Fixes inaccurate [`predict()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#arcgis.learn.MLModel.predict) results because training transformations were not incorporating training statistics\n",
@@ -248,6 +266,7 @@
     "  * [`PointCNN`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#pointcnn)\n",
     "    * Fixes bug with [`predict_las()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#arcgis.learn.PointCNN.predict_las) returning class codes from the model instead of the actual class codes in specific scenarios\n",
     "    * Fixes error message raised with [`from_model()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#arcgis.learn.PointCNN.from_model) if library dependencies are missing\n",
+    "    * Fixes [`show_results()`](file:///Users/john3092/Repos/geosaurus/docs/api_ref/build/html/arcgis.learn.toc.html?highlight=dice%20coefficient#arcgis.learn.PointCNN.show_results) and `show_batch()` when run against data object created with a `remap_classes` argument in [`prepare_data()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#prepare-data)\n",
     "* [`Object Detection Models`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#object-detection-models)\n",
     "  * [`SingleShotDetector`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#singleshotdetector)\n",
     "    * Fixes out of memory error when using [`show_results()`](https://developers.arcgis.com/python/api-reference/arcgis.learn.toc.html#arcgis.learn.SingleShotDetector.show_results) on model with multispectral data\n",