What's new in version 2.4.1

New

• Enhances documentation for arcgis.map module classes with type hinting
• New modules:
  • See What's New in 2.4.1 for additional details
  • arcgis.apps
    • arcgis.apps.itemgraph
      • New module designed to allow for cloning between organizations when in disconnected environments. The module provides functions and classes to allow building dependency graphs for items and downloading them. The download contains all necessary information to upload the items into another deployment.
      • Functions
        • create_dependency_graph()
        • load_from_file()
      • Classes
        • ItemGraph
        • ItemNode
• New classes:
  • OfflineContentManager
  • arcgis.graph module
    • See the API Reference for new data classes categorized by type that ensure valid inputs for the numerous specific types of objects that can be used as arguments for members within the module.

Guides

• What's New in 2.4.1
• Deprecation Notices 2.4.1
• Deep Learning
  • 2D Computer Vision
    • Object Detection
      • RT-DETRv2 Object Detector

Samples

• Deep Learning
  • NLP
    • Information extraction from Cheshire fire incident reports using Mistral language model

Module Changes

arcgis.gis

• GIS
  • Adds support for login profiles to cache OAuth refresh tokens, supporting persistent authentication of 3rd party identity providers
• Item
  • New properties:
    • attachments_size
  • New methods:
    • generate_api_token()
  • move()
    • Adds support for Folder objects
  • content_status
    • BUG-000170973 - Updates documentation for available options and adds link to requirements
  • download()
    • Adds validation and internal processing to improve performance
  • register()
    • New parameter:
      • personal_token
• ContentManager
  • import_table()
    • Adds support for folder parameter
  • analyze()
    • Adds documentation note to file_type parameter that geojson support is available for ArcGIS Online
  • add()
    • Adds note about support for overwrite
• Folders
  • create()
    • New parameter:
      • exist_ok
• Folder
  • add()
    • New parameter
      • upload_file_size - to support user import for larger part size for large files
      • stream - to support rare casses when ArcGIS Enterprise does not allow streaming uploads
  • delete()
    • Adds documenation for return value
• UserManager
  • advanced_search()
    • Updates link endpoint for a reference to further information
• User
  • delete()
    • Updates warning message when attempting to delete a User who still owns items
  • folders
    • Updates reference documentation with code snippet
  • items()
    • Updates reference documentation with explanation and code snippet
• GroupMigrationManager
  • create()
    • New parameter:
      • export_folder
  • load()
    • New parameter:
      • folder_name
• OrgRecycleBin
  • Adds reference documentation and code snippets for content() method
• ViewManager
  • Adds code snippet for initialization and updates reference documentation for methods

arcgis.gis Enumerations

• SpatialRelationship
  • Adds ability to import directly

arcgis.gis Dataclasses

• SpatialFilter
  • Updates documentation with code snippets and explanation
  • Adds ability to import directly

arcgis.gis.admin

• Reorganized Table of Contents to have distinct Kubernetes section
• AGOLUsageReports
  • generate_report()
    • New parameter:
      • time_aggregate
• LicenseManager
  • all()
    • Updates error message when there are expired licenses within the organization
• Logs
  • query()
    • New parameter:
      • federated_servers

arcgis.gis.server

• ReportManager
  • create()
    • Updates reference documentation links and queries parameter description
• LogManager
  • query()
    • Updates documentation with parameter details and code snippet

arcgis.gis.agonb

• NotebookManager
  • execute_notebook()
    • Updates reference documentation

arcgis.gis.workflowmanager

• New classes:
  • ExecutionStatus
  • JobExecution
  • MessageType
  • Notification
• WorkflowManager
  • create_diagram()
    • New parameters:
      • centralized_data_references
      • use_centralized_data_references
  • update_diagram()
    • Adds code snippet for using centralized_data_references in body argument
• Job
  • set_job_version()
    • Adds support for Centralized Data References

arcgis.gis.tasks

• Adds code snippets and formatting for all members
• New properties:
  • properties
    • Task
    • Run

arcgis.features

• FeatureLayer
  • query()
    • Improves performance by adding multiprocessing and parameter refinement internally
  • edit_features()
    • Updates reference documentation with examples of returned values
  • append()
    • Updates reference documentation with notes for further reading and how to find supported formats
• Spatially Enabled DataFrame - GeoAccessor
  • Adds documentation on how to control spatial processing engine for applicable methods
  • plot()
    • Adds check to use existing renderer if present in DataFrame
• OrientedImageryLayer
  • Adds Table of Contents heading and documentation

arcgis.features.analysis

• find_point_clusters()
  • Updates documentation with version availability information for time_field, search_time_interval, and search_time_unit parameters

arcgis.features.managers

• FeatureLayerCollectionManager
  • create_view()
    • New parameter:
      • folder
• UtilityNetworkManager
  • Deprecates result_type parameter for:
    • export_subnetwork()
    • trace()
• FeatureLayerManager
  • Updates documentation for schema change calls (*definition())) with snippet and reference links

arcgis.raster.functions

• subset_bands()
  • New parameters:
    • exclude_bad_bands
• raster_collection_function()
  • New parameters:
    • where_clause
    • query_geometry
    • use_input_geometry

arcgis.notebook

• execute_notebook()
  • Updates reference documentation explanation and adds code snippet

arcgis.geometry

• SpatialReference
  • Adds support for wkt2 format when initializing object
  • Updates internal inheritance to remove unnecessary members from objects

arcgis.graph

• New Data Classes:
• Data Model Types
  • ContraintRule
  • ConstraintRuleMask
  • Endpoint
  • EntityType
  • FieldIndex
  • GraphDataModel
  • GraphProperty
  • GraphPropertyMask
  • NamedObjectTypeMask
  • RelationshipExclusionRule
  • RelationshipExclusionRuleUpdate
  • SetOfNamedTypes
  • UpdateSetOfNamedTypes
• Graph Types
  • Entity
  • EntityDelete
  • Path
  • Relationship
  • RelationshipDelete
  • Transform
• Search Types
  • SearchIndex
  • SearchIndexProperties
• Response Types
  • ApplyEditsResponse
  • ConstraintRuleAddsResponse
  • ContraintRuleDeletesResponse
  • ConstraintRuleUpdatesResponse
  • IndexAddsResponse
  • IndexDeletesResponse
  • NamedObjectTypeAddsResponse
  • NamedObjectTypeUpdateResponse
  • NamedObjectTypeDeleteResponse
  • PropertyAddsResponse
  • PropertyUpdateResponse
  • SyncDataModelResponse
  • UpdateSearchIndexResponse

arcgis.layers

• Service
  • Adds support to initialize KnowledgeGraph services
  • Adds support to initialize WMSLayer from services
• Working with Map Service Layers
  • EnterpriseVectorTileLayerManager
    • edit()
      • Public Repo Issue #1889 - updates documentation to note the service must be stopped before editing in order for updates to be applied
• Working with OGC Layers
  • WMTSLayer
    • New method:
      • get_operational_layer_json()

arcgis.apps

• New Module:
  • itemgraph
• storymap
  • New Enumerations:
    • Result of Public Repo Issue #2031
      • CoverType
      • VerticalPosition
      • HorizontalPosition
      • CoverStyle
      • CoverSize
  • Adds new parameters make_copyable and no_seo to save() methods for following classes:
    • StoryMap
    • Briefing
    • Collection
  • Image
    • New properties:
      • full_view
      • link
  • Map
    • New property:
      • pinned_popup
• expbuilder
  • WebExperience
    • upload()
      • Add support for objects with custom widgets

arcgis.learn

• Adds dlpk support to TimeSeries models
• Adds wavelength parameter to support vit-based Dynamic One-For-All backbones to:
  • DeepLab, FasterRCNN, MaskRCNN, SingleShotDetector, FeatureClassifier, HEDEdgeDetector
• Adds mixed_precision training for:
  • SingleShotDetector, RetinaNet, FAsterRCNN, YOLOv3, RTDetrV2
• Data Preparation Methods
  • estimate_batch_size()
    • Adds support for RTDetrV2 model
• Automated Machine Learning
  • AutoDL
    • Adds RTDetrV2, SamLoRA, and Mask2Former as options for network argument
• Object Classification Models
  • FeatureClassifier
    • Updates methods to support GradCam
      • save()
      • show_results()
      • predict()
• 3D Models
  • New models:
    • PTv3Seg
    • PTv3Det
• Feature, Tabular, and Timeseries models
  • Enhances exception messaging if attempting to load older, incompatible models
  • MLModel
    • Implements the tabpfn model as option for model_type
• Raster Time Series Models
  • PSETAE
    • Adds backbone=None upon initialization
• Model Management
  • New class:
    • AIServiceConnection
  • train_model()
    • Adds support for cloud store paths as the output_name argument

Fixes

• Public Repo #2166 - Updates exception handling to include missing class so complete messaging appears

Guides

• Updates to numerous guides for Map methods

Samples

• GIS analysts and data scientists
  • Finding grazing allotments
    • Updates to basemaps and rendering code
• Deep Learning
  • 2D Computer Vision
    • Object Detection
      • Automate Road Survace Investigation Using Deep Learning
        • Fixes video rendering
  • Tabular Data Forecasting]
    • Updates formatting to correct rendering:
      • Predicting voters turnout for US election in 2016 using AutoML - Part 1
      • Predicting voters turnout for US election in 2016 using AutoML and spatial feature engineering - Part II
  • Time Series Forecasting
    • Forecasting Air Temperature in California using ResCNN model
      • Updates to map rendering

Module Changes

arcgis.gis

• GIS
  • BUG-000173116 - Fixes KeyError regaring role values when initializing with a public account
  • Fixes issue with recursion occurring on objects created using the generate token endpoint
  • Fixes population of internal User information for connections, such as using API Key, do not have explicit user
  • Fixes incorrect URL used for initialization with "home" keyword in a Notebook Server notebook
  • Fixes issues with initialization of objects using OAuth:
  • Fixes issue with duplicate imports leading to failures with interactive OAuth authorization
  • Fixes incorrect SSLError returned when initializing with publicly defined certificate
• Item
  • BUG-000171384 - Fixes error where tables property returned empty list when item is a Map Service
  • Fixes error when accessing layers in ArcGIS Notebooks using "home" authentication
  • download()
    • Fixes failures to download json structure for specific item types, such as Web Experiences, lacking specific headers
  • publish()
    • Public Repo Issue #2152 - Fixes incorrect behavior of waiting for job to finish on asynchronous operation
    • Fixes issue where Date Only fields were not handled appropriately
  • remap_data()
    • Fixes incorrect results issue with force=True if services had differing number of layers
  • update()
    • BUG0-000172092 - Fixes issue where thumbnail was being overwritten
• GroupManager
  • clone()
    • Fixes KeyError: 'membershipAccess' when cloning between ArcGIS Online organization
• Group
  • update()
    • Fixes TypeError...unexpected keyword argument 'auto_join' error
• GroupMigrationManager
  • load()
    • Fixes "Item does not exist error" on job result when items within the EPK item are skipped or fail to import
• SharingGroupManager
  • list()
    • Fixes situation where only 5 groups were being returned regardless of whether item was shared with more
• ContentManager
  • clone_items()
    • Public Repo Issue #2146 - Fixes issue where features failed to clone if layer id is not 0
    • BUG-000171865 - Fixes issue where only first item clones when cloning multiple dashboard items simultaneously
    • Public Repo Issue #1872 - Fixes IndexError when cloning items with an empty string as the name value
    • Fixes error when cloning items referencing services whose associated item has been deleted
    • Fixes issue with results not added after cloning Quick Capture items
    • Public Repo Issue #2147 - Fixes ItemCreateException when attempting to clone multiple items with copy_global_ids=True if any of the items do not contain global_id values
    • Public Repo Issue #2151 - Fixes error when cloning tile layer items using the copy_data=False argument failed with ItemCreateException
    • Fixes issue where copy_data=False was incorrectly creating hosted service items
• Folder
  • add()
    • Fixes issue where Date Only fields were not handled appropriately
    • Fixes empty results when adding Geoprocessing Service item if url is in the dictionary used for item_properties argument
• UserManager
  • create()
    • Fixes Unable to create <user_name> error on ArcGIS for Kubernetes deployments if New Member Defaults are not set
• User
  • BUG-000173279 - Changes how users are initialized when returned in searches so that the role property hydrates with custom role names
  • items()
    • Fixes issue where incorrect total number of results returned
• APIKey
  • update()
    • BUG-000170593 - Fixes Error Code 500 issue when update privileges on the APIKey
• ViewManager
  • create()
    • Updates documentation for set_item_id parameter to note suppported platform and version
• RoleManager
  • clone()
    • Fixes AttributeError regarding no name attribute

arcgis.gis Dataclasses

• SpatialFilter
  • as_json()
    • Fixes UnboundLocalError because internal Spatial Reference variable handled incorrectly

arcgis.gis.admin

• AGOLAdminManager
  • history()
    • BUG-000170507 - Removes raw and df options from the data_format parameter because of inconistent results
• PortalAdminManager
  • mode
    • BUG-000170798 - Updates reference code snippet to correctly set value
• AGOLUsageReports
  • generate_report()
    • Public Repo Issue #2145 - Fixes Specified output format not supported for various report_types, including activity, credits, serviceUsages, and itemUsages
• LivingAtlasManager
  • Raises log warning instead of error when attempting to initialize object when ArcGIS Enterprise is not configured for Living Atlas content
• SecuritySettings
  • register_idp()
    • BUG-000170083 - Fixes failure to register identity provider when using an idpMetadataFile
• License
  • user_entitlement()
    • BUG-000172452 - Fixes issue where ArcGIS Pro entitlement could not be retrieved from user_type which included ArcGIS Pro
• Logs
  • query()
    • Fixes no results being returned when using a query_filter argument
• HomePageSettings
  • set_footer()
    • BUG-000175070 - Fixes issue where show_text=False was not hiding the footer
• Kubernetes
  • KubernetesAdmin
    • Fixes initialization with admin property when using "home" authentication in ArcGIS Notebook

arcgis.gis.server

• DataStoreManager
  • validate()
    • BUG-000172692 - Fixes incorrect return value of False on valid datastores
• Service
  • Fixes missing documentation
• Server
  • Fixes AttributeError when initiliazing using the portal_connection argument
• LogManager
  • query()
    • Fixes issue where no results are returned if end_time argument provided as a string

arcgis.features

• FeatureLayer
  • query()
    • Fixes Cannot access local variable error if only OBJECTID field is set in out_fields argument
    • BUG-000171499 - Fixes issue with incorrect number of results returned on referenced services with result_record_count argument
  • edit_features()
    • Fixes Invalid 'editsUploadFormat' parameter error when running asynchronously on ArcGIS Enterprise
• Spatially Enabled DataFrame - GeoAccessor
  • insert_layer()
    • Fixes issue on ArcGIS Enteprise where layer schema was inserted but features were not
  • to_featureclass()
    • BUG-000171826 - Fixes issue where null values for Int32 or Float64 datatypes were converted to strings
  • to_featurelayer()
    • Fixes AttributeError: 'GIS' object has not attribute 'is_arcgisonline' error
    • Fixes Overwrite unsuccessful error and messaging when originated from a FeatureSet
    • Updates internal processing to improve performance on large files
  • compare()
    • Public Repo Issue #2214 - Fixes KeyError arising because the match_field name was being truncated
  • from_featureclass()
    • Fixes TypeError when location argument is an arcpy.mp.Layer object
    • Fixes KeyError when using a subset for the fields argument in arcpy environments
    • Public Repo Issue #2241 - Fixes issues with reading projection information incorrectly depending upon avaialble Geometry Engines
  • from_layer()
    • Fixes issue with duplicate records returned on Feature Layer objects hosted in ArcGIS Enteprise created with this method
• FeatureCollection
  • from_featureset()
    • Updates url endpoint for Esri Symbol Page link in symbol parameter description
      

arcgis.features.managers

• FeatureLayerCollectionManager
  • Fixes AttributeError: 'dict' object has no attribute 'result' errors with definition calls to ArcGIS Online
  • update_definition()
    • Fixes Invalid definition error when updating editorTrackingInfo
  • create_view()
    • BUG-000169543 - Fixes PropertyMap instance has no _serviceItemId_ error on ArcGIS Enterprise resulting in an empty view
  • overwrite()
    • BUG-000173138 - Fixes Error getting Item Info from Datastore error when using on hosted tables published from service definition files
• FeatureLayerManager
  • Fixes issue where layer failed to refresh after calls updating the definition
• AttachmentManager
  • count()
    • Fixes KeyError: 'count' when calling method
  • search()
    • Fixes situation where all records were returned instead of specific results

arcgis.raster.orthomapping

• Project
  • Fixes issue where gis argument was not used for initialization

arcgis.geoenrichment

• encrich()
  • BUG-000171775 - Fixes AttributeError with the KeyFacts data collection

arcgis.geometry

• BUG-000173067 - Fixes issue where importing "*" from module overrides GIS object
• Geometry
  • as_shapely()
    • Public Repo Issue #2211 - Fixes inconsistency in output from this method versus using the shapely library directly for MultiPolygon geometry type

arcgis.layers

• Working with OGC layers
  • WMSLayer
    • BUG-000166785 - Fixes issue with failed visualization and navigation on layer with sublayers
  • WMTSLayer
    • Public Repo Issue #2098 - Fixes failure to visualize service layers when service contains muliple layers and tilematrixsets
• Working with Map Service Layers
  • MapImageLayer
    • identify()
      • Public Repo Issue #2169 - Fixes Missing 'geometry' error even though Geometry object is provided
      • Fixes issue where the layers argument set to all not returning results from all layers
  • VectorTileLayer
    • export_tiles()
      • Fixes error when entering export_extent or polygon argument as a dictionary
      • Updates validation to make sure spatial references match
• Utility Functions for Mapping
  • Fixes rendering error for reference documentation

arcgis.map

• MapContent
  • add()
    • Fixes issue where FeatureSets were not displaying if OBJECTID field was not in the fields list
• PopupManager
  • Updates support for working with table objects

arcgis.apps

• survey123
  • Survey
    • publish()
      • Fixes 500 Error with Spatial Reference WKIDs when publishing on ArcGIS Enteprise
      • Fixes Invalid definition error when publishing
    • update_report_template()
      • Fixes TypeError when using operation
• workforce
  • create_project()
    • Adds reference documentation for function
  • arcgis.apps.workforce.managers
    • WorkerManager
      • add()
        • BUG-000171541 - Fixes KeyError when using on ArcGIS Enterprise
    • AssignmentManager
      • batch_delete()
        • BUG-000167379 - Fixes KeyError when running operation
• storymap
  • Table
    • Fixes issue where strings were not being accepted as input for cells
• Briefing
  • copy_content()
    • Fixes issue where Briefing objects and _express map dependents were not copied correctly into second briefing
• expbuilder
  • WebExperience
    • Fixes error when initializing on ArcGIS Enteprise if the gis object created from a url ending in "/home"
    • upload()
      • Fixes error with offline Experiences with no image resource file

arcgis.learn

• Deprecates the overwrite parameter in save() methods for all models
• Fixes overutilization of GPU memory during inferencing for numerous models
• Fixes ValueError when using Language Pack to classify pixels
• Fixes URLError when usig _from_model() to load models if the torch cache is cleared or unavailable
• Fixes issue with weight loading on Prithvi models
• Fixes issue with output not appearing in notebooks if models are trained before optimized with lr_find()
• Data Preparation Methods
  • prepare_data()
    • Fixes error with ClimaX data on Linux Operating Systems
    • Fixes WellKnownBandNames error if the EMD key is not available
    • Fixes AssertionError when using ClimaX models for forecasting monthly
    • Updates vague description for path argument to clarify when lists are necessary
  • prepare_textdata()
    • Updates class_mapping parameter description with applicability information
• Automated Machine Learning
  • AutoDL
    • Adds RTDetrV2, SamLoRA, and Mask2Former as options for network argument
    • Deprecates support for OCRNet as option for network argument
    • fit()
      • Fixes issue when using default backbone in advanced mode
  • AutoML
    • Fixes error training models because of hard-coded extraneous data
• Object Classification Models
  • FeatureClassifier
    • plot_hard_examples()
      • Fixes mismatch in predicted class treated as single-label when it is multi-label
  • MaskRCNN
    • Fixes high GPU memory usage issues
• Object Detection Models
  • RetinaNet
    • Fixes training and optimization crashes on machines with only a CPU
• Pixel Classification Models
  • Fixes incorrect NoData cells display issue with show_results() on Multispectral edge detection models
  • BDCNEdgeDetector
    • Fixes RuntimeError when training or optimizing with specific timm backbones
  • MMDetection
    • fit()
      • Fixes RuntimeError failure when training with _mixed_precision
  • DETReg
    • lr_find()
      • Fixes RuntimeError when called with mixed_precision
  • MultiTaskRoadExtractor
    • Fixes training and optimization RuntimeErrors on initial run with models initialized from linknet backbones
      • Deprecates support for using linknet backbones with multiple GPUs
• Image Translation Models
  • WNet_cGAN
    • lr_find()
      • Fixes Out of memory error when using data prepared with batch_size=None
• 3D Models
  • SQNSeg
    • fit()
      • Fixes NaN validation errors and training losses with _mixed_precision
• Object Tracking Models
  • SiamMask
    • save()
      • Fixes AssertionError when called on models trained with mixed_precision
• Feature, Tabular, and Timeseries models
  • Fixes AttributeError caused by Pandas datetime on TimeSeries models when using show_results() or show_batch()
  • MLModel
    • from_model()
      • Fixes Invalid data type error when setting emd_path to a Deep Learning Package item
      • Fixes AttributeError stemming from version mismatch with sklearn when loading from older models in emd_path argument
    • predict()
      • Fixes TypeError when explain=True on Tree-based models
      • Fixes ValueError when mitigating with fairness arguments on Regression models
• Raster Time Series Models
  • ClimaX
    • Fixes inferencing failures on models trained with multidimensional data in ArcGIS Pro
  • PSETAE
    • Fixes NotADirectory error and issue dropping last point when training
    • from_model()
      • Fixes TypeError when loading from model trained with mixed_precision
• Unstructured Text Models
  • arcgis.learn.text module
    • EntityRecognizer
      • Corrects the function name in data parameter that returns output for the argument
    • TextClassifier
      • predict()
        • Fixes error processing column names with spaces when using Mistral backbone
      • fit()
        • Fixes TypeError when trying to find learning rate
    • SequenceToSequence
      • fit()
        • Fixes mixed_precision TypeError when trying to find learning rate
    • Pix2PixHD
      • fit()
        • Fixes cuda assert RuntimeError when run with lsgan=False
• Inferencing Methods
  • classify_objects()
    • Fixes RuntimeError when a partial input feature is selected during extent setting
• Model Management
  • train_model()
    • Fixes ZeroDevisionError if batch size is larger than the number of chips in the data
    • Fixes intermittend job crashes when run on ArcGIS Enterprise on Linux