What's new in version 2.3.0

Note: Includes all updates since the release of version 2.2.0

New

• New implementation for sharing to fully align with REST API best practices:
  • SharingManager - for managing Item sharing
  • SharingGroupManager - for managing Item sharing to Groups
• New implementation for Folder management:
  • Folders
  • Folder
    • add()
      • uses streaming for performance improvements when adding items
• Adds management capability for Partnered Collaborations
• arcgis.apps.survey23
  • Adds support to:
    • publish Survey123 survey items based on ArcGIS Survey123 Ideas 968118
    • add, update, and delete webhooks based on ArcGIS Survey123 Question 1234777
• Adds support for 3D Tile Layers

Guides

• Deep Learning
  • 2D Computer Vision
    • Other Imagery Topics
      • How SR3 super-resolution works
  • 3D Computer Vision
    • Point cloud classfication using RandLA-Net
    • Point cloud classfication using SQN
• Content Management
  • Cloning and Troubleshooting Complex Items

Samples

• Deep Learning
  • 2D Computer Vision
    • Pixel Classification
      • Mangrove forest monitoring using deep learning
    • Using Pre-trained Models
      • Cloud removal using pretrained deep learning model and raster function
  • Time Series Forecasting
    • Forecasting power consumption in Tetouan City using Deep Learning Time Series techniques

Module Changes

arcgis.gis

• Adds support for Data Pipeline items
• Adds classes:
  • SharingManager
  • SharingGroupManager
  • Folders
  • Folder
• GIS
  • ENH-000160434 - Adds support for string datatype to the verify_cert parameter to accomodate certificate updates
• User
  • report()
    • Adds parameter:
      • time_aggregate
    • Adds code snippet
    • Adds parameter options for report_type
      • serviceUsages
      • itemUsages
• UserManager
  • send_notification()
    • Adds deprecation message when using method on ArcGIS Enteprise in response to Public Repo Issue #1642
  • user_groups()
    • Adds support for returning more than 20 values
• ContentManager
  • New properties:
    • folders
  • clone_items()
    • Adds support for Data Pipeline items
    • Adds error messaging when cloning items that do not support the item_mapping argument
  • search()
    • Adds parameter to address Public Repo Issue #1413:
      • filter
  • advanced_search()
    • Adds parameter to address Public Repo Issue #1413:
      • filter
• Item
  • Adds deprecation warnings for removal in future release of:
    • share()
    • shared_with
  • Adds properties:
    • sharing
  • Adds methods:
    • can_reassign()
  • related_items(()
    • Adds paging support
  • delete()
    • Adds support for permanent argument to permanently delete items from organizations opted into Recycle Bin functionality
  • update()
    • Adds error messaging when run on file type items if the item_properties is missing a fileName value
  • publish()
    • Adds future parameter to allow for running asynchronously
• Group
  • remove_users()
    • Updates documentation for usernames parameter
  • notify()
    • Adds message indicating method is not supported with ArcGIS Enterprise
• CategorySchemaManager
  • Adds property
    • schema_paths
• GroupManager
  • create()
    • Adds deprecation note for use of autojoin parameter in favor of auto_join

arcgis.gis Enumerations

• ItemTypeEnum
  • Adds support for new item types:
    • TILES_PACKAGE_3D
    • TILES_SERVICE_3D

arcgis.gis.admin

• Adds class:
  • Response to BUG-000154442:
    • PartneredCollabManager
    • PartneredCollaboration
• Updates scheduled_tasks() methods on all admin classes to return list of Task objects:
  • AGOlAdminManager
  • PortalAdminManager
  • KubernetesAdmin
• AGOLUsageReports
  • Adds caching to various methods for performance improvement
• PortalAdminManager
  • Adds method:
    • content()
• AGOLAdminManager
  • Adds method:
    • content()
  • Adds property:
    • partnered_collaboration
• MapSettings
  • Adds properties:
    • use_3d_basemaps
  • update_basemap_gallery()
    • Adds check to both remove deprecated basemaps and update any new basemaps added to group shared with basemap group
• System
  • Adds support for limits functionality:
    • getting - limits
    • setting - set_limits()
• SystemManager - Kubernetes
  • Updates properties setter to allow for additional publishers and control of process timeouts
• CreditManager
  • Adds code snippets for:
    • object initialization: CreditManager
    • allocate()
    • credit_usage()

arcgis.gis.server

• Service
  • edit()
    • Adds parameter:
      • future - to allow aychnronous processing

arcgis.gis.workflowmanager

• Job_Manager
• Adds method:
  • statistics()
• update()
  • Adds parameter:
    • allow_running_step_id
• Job
  • Adds method:
    • add_hold()
  • update_step()
    • Adds code snippet

arcgis.gis.tasks

• TaskManager
  • create()
    • Adds parameter documentation:
      • task_url
    • Updates parameter documentation for:
      • cron
      • parameters
  • search()
    • Adds options for types parameter

arcgis.features

• Adds class:
  • OrientedImageryLayer
• refactor of query() methods with internal processing performance improvements
• FeatureLayer
  • Adds method:
    • query_3d()
  • edit_features()
    • Runs internal operations asynchronously when applicable for performance improvements
  • append()
    • Updates documentation in upload_format to indicate how to determine supported formats
• Spatially Enabled DataFrame - GeoAccessor
  • Adds support to time only objects to align with ArcPy and ArcGIS Enterprise
• FeatureLayerCollection
  • Adds code snippets and explanations for initializing objects
  • extract_changes()
    • Adds code snippet and description text for servergen parameter
    • Adds code snippet for layer_servergen parameter

arcgis.features.managers

• Adds reference documentation:
  • TraceConfigurationsManager
• FeatureLayerCollectionManager
  • Adds method:
    • swap_view()
  • create_view()
    • Adds parameters:
      • visibile_fields
      • query
• SyncManager
  • synchronize()
    • Adds reference documentation
• UtilityNetworkManager
  • Updates reference documentation for numerous method and property descriptions
  • Adds note on user_type requirements
• TopographicProductionManager
  • generate_product()
    • Adds parameter
      • output_settings
    • Updates parameter documentation with code snippets
      • version
• TraceConfiguration
  • Adds property to initializer:
    • use_digitized_direction
    • synthesize_geometry
• ParcelFabricManager
  • divide()
    • Adds parameter:
      • divide_associated_lines

arcgis.features.analysis

• Adds function documentation:
  • generate_tesselation()

arcgis.features.analyze_patterns

• Adds function:
  • calculate_composite_index()
• find_point_clusters()
  • Adds parameter:
    • method
    • sensitivity
    • time_field
    • search_time_interval
    • search_time_unit
  • Updates documentation to clarify implementation details
• find_outliers()
  • Adds randomGenerator seeding option for the context argument

arcgis.features.find_locations

• find_similiar_locations()
  • Adds parameters:
    • criteria_fields

arcgis.features.summarize_data

• join_features()
  • Adds support to return count only by using COUNT for statisticType and None for onStatisticField

arcgis.features.manage_data

• extract_data()
  • Adds parameter:
    • context
• derive_new_locations()
  • Adds parameter table documentation

arcgis.raster

• Adds estimate parameter to appropriate methods to approximate credit cost of operations in ArcGIS Online
• ImageryLayer
  • Adds support for Tiled Imagery Layer items
  • Adds method:
    • find_images()
    • image_to_map()
    • map_to_image()
    • get_image_url()
    • image_to_map_multiray()
    • measure_from_image()
• RasterCollection
  • Adds support for more STAC datasets:
    • Adds context parameter to:
      • from_stac_api()
        • See also stac_api parameter description
      • from_stac_catalog()
        • See also stac_catalog parameter description
• Raster
  • Adds support for more STAC datasets:
    • Adds context parameter:
      • from_stac_item()
        • See also stac_item parameter description

arcgis.raster.analytics

• Adds estimate parameter to all functions to approximate credit cost of operations in ArcGIS Online
• New functions:
  • locate_regions()
  • transfer_files()
  • tabulate_area()
  • zonal_geometry_as_table()
• create_viewshed()
  • Adds new parameters:
    • vertical_error
    • refractivity_coefficient
    • horizontal_start_angle
    • horizontal_end_angle
    • vertical_upper_angle
    • vertical_lower_angle
• summarize_raster_within()
  • Adds options for statistic_type argument:
    • MAJORITY_COUNT
    • MAJORITY_PERCENT
    • MINORITY_COUNT
    • MINORITY_PERCENT
• zonal_statistics_as_table()
  • Adds options for statistic_type argument
    • MAJORITY_COUNT
    • MAJORITY_PERCENT
    • MINORITY_COUNT
    • MINORITY_PERCENT
    • MAJORITY_VALUE_COUNT_PERCENT
    • MINORITY_VALUE_COUNT_PERCENT

arcgis.raster.functions

• Adds function:
  • create_color_composite()
• remap()
  • Adds parameter:
    • replacement_value

arcgis.raster.functions.gbl

• zonal_statistics()
  • Adds options for statistic_type argument
    • MAJORITY_COUNT
    • MAJORITY_PERCENT
    • MINORITY_COUNT
    • MINORITY_PERCENT

arcgis.raster.orthomapping

• Adds error messaging when attempting to create an item from one which is not an Orthomapping Project
• Adds support for managing projects and missions
  • Mission
    • Adds method:
      • delete_product()
      • reset()
      • delete()
  • Project
    • Adds method:
      • delete()

arcgis.network

• Adds class:
  • NetworkDatasetLayer
  • LocateSettings
• Adds enumeration:
  • ToleranceUnits
  • SolverType
• Adds function:
  • publish_routing_services()
• Adds parameter documentation to solve() methods:
  • locate_settings
  • return_empty_results
• ServiceAreaLayer
  • solve_service_area()
    • Adds parameter documentation:
      • include_source_information_on_lines

arcgis.network.analysis

• Adds function:
  • get_tool_info()
• Adds parameter documentation for these parameters to all tools:
  • ignore_network_location_fields
  • locate_settings
• Adds parameter documentation for these parameters to all tools except edit_vehicle_routing_problem and solve_vehicle_routing_problem
  • accumulate attributes
  • ignore_invalid_locations
• Adds parameter documentation to generate_service_areas()
  • exclude_sources_from_polygon_generation

arcgis.notebook

• execute_notebook()
  • adds ability to cancel asynchronous job

arcgis.geometry.functions

• Reorganized API Reference table of contents
  • Adds Enumerations and Functions subheadings
• Adds class:
  • GeometryJob

arcgis.graph

• KnowledgeGraph
• Adds methods:
  • sync_data_model()
  • graph_property_index_adds()
  • graph_property_index_deletes()
  • constraint_rule_adds()
  • constraint_rule_deletes()

arcgis.mapping

• refactor of query() methods with internal processing performance improvements
• Working with 2D Maps
  • OfflineMapAreaManager
    • Updates reference documentation with important notes and links regarding Web Map configuration
    • Extends code snippets
• Working with 3D Maps
  • Adds class:
    • Tiles3DLayer

arcgis.apps

• storymap
  • Adds classes:
    • Briefing
    • Code
    • Table
    • ExpressMap
    • Block
    • Collection
  • Adds enumerations:
    • Language
    • TextStyles
    • SlideLayout
    • SlideSubLayout
  • Storymap
    • Adds deprecation note for following members in favor of content_list property:
      • get()
      • nodes
    • duplicate()
      • Updates internal processing so identical workflows used for ArcGIS Online and ArcGIS Enterprise
  • Text
    • Adds methods:
      • add_attachment()
      • remove_attachment()
• survey123
  • Survey
  • Adds method:
    • publish()
    • add_webhook()
    • delete_webhook()
    • update_webhook()
  • generate_report()
    • Adds links to detailed documentation
• expbuilder
  • Performance improvements upon imports:
    • Enhances templates to use separate files for storage
    • Adds lazy loading to all imports in module
    • Adds warning to indicate if template is newer than the ArcGIS Enteprise
  • WebExperience
    • clone()
      • Adds deprecation message as items are now supported with ContentManager.clone_items()

arcgis.learn

• Adds error checking when predict() method run on unsupported multrispectral data
• Adds error messaging when sensitive_feature argument is not of correct type when using fairness_score() method
• Data Preparation Methods
  • prepare_data()
    • Updates channels_of_interest documentation description for PSETAE model
    • Adds support for the num_workers argument for:
      • ChangeDetector
      • Pix2Pix
      • Pix2PixHD
      • SiamMask
• Automated Machine Learning
  • AutoML
    • predict()
      • Adds support for remote deep learning package items
  • DETReg
    • Updates documentation to indicate support for resnet50 backbone only
  • EfficientDET
    • Adds default information to backbone parameter documentation
• Pixel Classification Models
  • New models:
    • SamLoRA
  • Integrates prithivi fine-tuning models
    • prithivi100m_burn_scar
    • prithivi100_crop_classification
    • prithivi100m_sen1floods
    • prithivi100m
  • Updates mIOU calculation to use entire dataset rather than per image
  • MMSegmentation
    • Adds transformer based model support for:
      • mask2former
• Image Translation Models
  • SuperResolution
    • Integrates support for SR3_UiVT backbone with optional initialization parameters
      • patch_size
      • embed_dim
      • depth
      • num_heads
      • mlp_ratio
      • qkv_bias
• 3d Models
  • Adds focal_loss option when initializing:
    • PointCNN
    • SQNSeg
    • RandLANet
• Feature, Tabular, anad Timeseries models
  • TimeSeriesModel
    • show_results()
      • Adds documentation about experimental support for multivariate time series
• Unstructured Text Models
  • arcgis.learn.text module
    • Adds LLM backbone support to text analysis models:
      • EntityRecognizer
      • SequenceToSequence
      • TextClassifier
    • Adds support for Mistral to:
      • TextClassifier
      • EntityRecognizer
    • EntityRecognizer
      • Adds support for CSV files

Fixes

Guides

• Install and set up
  • Docker
    • Updates to instructions
  • Google Colaboratory
    • Updates to instructions
• Deep Learning
  • 2D Computer Vision
    • Object Detection
      • YOLOv3 Object Detector
        • updates information regarding COCO pretrained weights
  • 3D Computer Vision
    • Point Cloud Segmentation using PointCNN
      • general content updates

Samples

• Deep Learning
  • 3D Computer Vision
    • Updates data for Classification of SfM-derived point clouds using deep learning

Module Changes

arcgis.gis

• GIS
  • Fixes BUG-000164527 where A general error occurred message is returned when invalid credentials entered for initialization
• Item
  • share()
    • Fixes BUG-000158847 whereitem was not properly sharing to a Shared update group
  • metadata
    • Fixes issues with writing to directories that caused IO errors during clone operations
• ContentManager
  • clone_items()
    • Fixes BUG-000162768 where ItemCreateException returned when Unicode characters in the name
    • Fixes BUG-000163916 where cloning multiple Survey123 items simultaneously failed with permissions error
    • Fixes BUG-000161757 where web maps embedded in Suvery123 form questions failed to clone
    • Fixes issue where StoryMap items with ExpressMap componenets caused method to run in a loop
• Group
  • add_users()
    • Fixes BUG-000158059 where incorrect parameter name of admin appeared in code snippet
• User
  • report()
    • Fixes ValueError when using weekly or monthly for duration argument
• UserManager
  • org_search()
    • Fixes issue where exclude=True returned system account users

arcgis.gis.admin

• DataStoreMetricsManager
  • feature_storage
    • Fixes percentage values with M1-M4 storage types

arcgis.gis.server

• LogManager
  • query()
    • Fixes Public Repo Issue #1722 where KeyError 'hasMore' returned on older releases of ArcGIS Enterprise
• ServerManager
  • get()
    • Fixes error where error returned on certain Server roles

arcgis.gis.nb

• NotebookManager
  • execute_notebook()
    • Fixes issue where incorrect job id was returned from asynchronous execution

arcgis.gis.tasks

• TaskManager
  • create()
    • Fixes NameError returned in notebooks created with task_type=ExecuteNotebook

arcgis.gis.sharing

• MarketPlaceManager
  • purchase()
    • Fixes BUG-000164179 where method fails with "Exception: purchaser org id not specified (Error Code: 400)"

arcgis.features

• FeatureLayer
  • query()
    • Fixes AttributeError with GeoArray when setting as_df=True
    • Fixes issue where results returned as a dictionary instead of FeatureSet
    • Fixes issue where return_count_only=True failing to return integer
  • edit_features()
    • Fixes Public Repo Issue #1768 issue where Pandas NaT values in date fields are updated to 0 instead of None
• FeatureLayerCollection
  • extract_changes()
    • Fixes BUG-000156249 documentation error with serverGen value types
• Spatially Enabled DataFrame (GeoAccessor)
  • plot()
    • Fixes issue with mapping of layers containing following field types:
      • esriFieldTypeBigInteger
      • esriFieldTypeDateOnly
      • esriFieldTypeTimeOnly
      • esriFieldTypeTimestampOffset
    • Fixes rendering to be based upon layer rendering information
  • to_featureclass()
    • Fixes errors when using versions prior to ArcGIS Enteprise 11.1 for Int64 support
  • to_featurelayer()
    • Fixes Public Repo Issue #1700 where overwrite=True created duplicate layers
    • Fixes error in boolean handling for NA values
  • to_featureset()
    • Fixes Public Repo Issue #1693 where multiple date fields resulted in all dates set to the last date value
  • set_geometry()
    • Fixes Public Repo Issue #1754 where sr argument was not set properly
    • Fixes issue with reprojecting occurring after multiple calls to method
• GeoSeriesAccessor (geom namespace on SHAPE column)
  • equals()
    • Fixes Public Repo Issue #1767 where method always returned None
• FeatureSet
  • Fixes initialization of objects when only one feature is present

arcgis.features.managers

• Fixes internal representation of GUID values on Oracle and PostgreSQL databases for:
  • VersionManager
  • UtilityNetworkManager
• FeatureLayerCollectionManager
  • overwrite()
    • Fixes BUG-000160121 by adding error message when attempting to use local files to overwrite from ArcGIS Online notebooks
    • Fixes internal logic for checking file size limits
  • create_view()
    • Updates documentation to clarify overwrite parameter functionality
    • Fixes BUG-000162549 where method returns an empty view from Feature Layer items published from Survey123
    • Fixes incorrect output for tags leading to an array appearing instead of individual strings
• AttachmentManager
  • add()
    • Fixes issue with certain binary files being rejected
• WebHoookServiceManager
  • Fixes BUG-000164125 :
    • create()
      • Fixes KeyError: 'globalId' error
    • list()
      • Fixes TypeError on object created with url argument using /webhooks endpoint

arcgis.features.find_locations

• find_existing_locations()
  • Fixes incorrect parameter type documentation for expressions

arcgis.features.manage_data

• extract_data()
  • Fixes documentation issue with invalid output when using output_name argument extracting to CSV or File Geodatabase
  • Fixes wrong parameter type documentation for:
    • input_layers
    • extent

arcgis.features.summarize_data

• Removes incorrect method from website Table of Contents
  • describe_dataset()
• join_features()
  • Fixes formatting issues with parameter table:
    • spatial_relationship_distance
    • spatial_relationship_distance_units

arcgis.raster

• ImageryLayer
  • Fixes TypeError and lerc error when rendering tilesonly services
  • render_tilesonly_layer()
    • Fixes issue with layer saved from function not displaying properly

arcgis.raster.analytics

• train_classifier()
  • Fixes failure on ArcGIS Online when using unsupported parameter when should still run

arcgis.raster.functions

• clip()
  • Fixes issue where clip_outside=False was being ignored

arcgis.raster.functions.gbl

• Fixes iussue where Distance functions were using incorrect default sizes when writing to cloud stores

arcgis.raster.orthomapping

• Fix to guarantee project names are unique
• Fixes to issues when input is an image collection rather than a mission for:
  • generate_orthomosaic
  • reset_image_collection
• Project
  • add_mission()
    • Fixes RuntimeError failing to add mission when method is not provided GPS info
• Mission
  • products
    • Fixes failure to return properties if any Item is None
• query_camera_info()
  • Fixes issue with dictionary input as the camera_query argument

arcgis.geocoding

• PlacesAPI
  • Fixes issue where categories parameter value was ignored
    • search_by_extent()
    • search_by_radius()

arcgis.geoenrichment

• enrich()
  • Fixes error in general code execution with certain standard_geography_query input

arcgis.geometry.functions

• Fixes BUG-000154257 where some functions returned a The opertion was attempted on an empty geometry 400 error when proper formatting not used for offset_units argument

arcgis.mapping

• Working with 2D Maps
  • WebMap
    • move_to_basemap()
      • Fixes Public Repo Issue #1739 unsupported layer type error when moving VectorTileOnly type basemaps
    • basemap_title()
      • Fixes Public Repo Issue #1763 where entering None for method sets title to null
  • OfflineMapAreaManager
    • offline_properties
      • Fixes KeyError when attempting to set properties

arcgis.apps

• expbuilder
  • WebExperience
    • clone()
      • Updates handling of item_mapping
    • save()
      • Fixes errors on saving new experiences
• hub
  • SiteManager
    • clone()
      • Fixes BUG-000163652 where ouput hub site was invalid

arcgis.learn

• Data Preparation Methods
  • estimate_batch_size()
    • Fixes issue where method overestimates in evaluation mode for some Object Detection models
  • Transform3d
    • Fixes jitter values to be float only
• Automated Machine Learning
  • AutoDL
    • Fixes error initialzing object when no network argument provided
  • AutoML
    • fit()
      • Fixes AttributeError with metapack environment for regression
    • predict()
      • Fixes issue when output_layer_name already exists
    • score()
      • Fixes issue where negative value is returned with eval_metric set to mse or rmse on the data
    • fairness_score()
      • Fixes IndexingError: Unalignable boolean Series provided as indexer error with regression models
  • ImageryModel
    • save()
      • Fixes issue where method was not printing the saved path
• Object Classification Models
  • FeatureClassifier
    • Fixes crashing errors with tensorflow backend and specifying a backbone
    • Fixes <urlopen error> with timm backbones
    • predict()
      • Fixes TypeError when visualize=True with timm backbones
    • fit()
      • Fixes ValueError: Expreted more than 1 value per channel when training... error when run on data preparted with a batch_size of 1
    • save()
      • Fixes failure when using transformer models and tflite framework
• Object Detection Models
  • Fixes warning messages when initializing objects
  • Fixes training failures for models when run on multiple-GPU machines
  • Fixes issues with timm backbnones not working for:
    • SingleShotDetector
    • RetinaNet
    • FasterRCNN
  • DETReg
    • fit()
      • Fixes ValueError when model is trained with consecutive runs
  • EfficientDET
    • fit()
      • Fixes AttributeError 'float' object has no attribute 'dtype'
• Pixel Classification Models
  • Fixes issue where fit() retuns NaN values in the dice scores with data that has class values missing in the label files
  • Fixes ValueError: Expected more than 1 value per channel when training when using fit()
  • Fixes ignore_classes in semantic segmentation models when reduction parameter set to mean
• Image Translation Models
  • ImageCaptioner
    • bleu_score()
      • Fixes TypeErrror with beam_width and max_len values
    • predict()
      • Fixes AttributeError with object using multispectral data
    • show_results()
      • Fixes incorrect default values for beam_width and max_len
• 3d Models
  • Fixes issue when reading multiple files
  • Fixes ValueError too many values to unpack error on consecutive runs without running prepare_data() in between for:
    • PointCNN
    • RandLANet
  • PointCNN
    • predict_h5()
      • Fixes issue where no output produced when inferencing
    • Fixes Public Repo Issue #1361 `AttributeError: module 'display' has no attribute 'display_html' error when visualizing in ArcGIS Pro or Jupyter Notebook for:
      • show_results()
      • show_batch()
• Object Tracking Models
  • DeepSort
    • from_model()
      • Fixes ValueError: semaphore or lock released too many times error when called without data object
• Feature, Tabular, anad Timeseries models
  • MLModel
    • Fixes initialization issue when prepare_tabulardata preprocessors used explanatory_variables without transformation
    • fairness_score()
      • Fixes ValueError with regression models
  • TimeSeriesModel
    • predict()
      • Fixes ValueError cannot convert to 'float64'-dytpe... with Pandas 2.0
• Unstructured Text Models
  • arcgis.learn.text module
    • Fixes RuntimeError using from_model() with previously saved text tools caused by missing attention mask
    • EntityRecognizer
      • Fixes IndexError when initializing object for LLM backbones