New
- Dependency Upgrades to improve overall security and performance of the API
- Updates supported Python versions to between 3.9 - 3.11
- Note: arcgis.learn module only supported with Python 3.9
- Pandas upgraded to 2.0.0
- Ensure support for all dtypes
- Updates supported Python versions to between 3.9 - 3.11
- New submodule to work with ArcGIS Experience Builder items
Guides
- Deep Learning
- Administration
Samples
Module Changes
arcgis.gis
- Adds classes:
User- Adds methods:
- Adds properties:
generate_direct_access_url()- Updates documentation for supported platforms
UserManagercreate()- Adds parameters:
email_textfor custom messages
- Adds note to password parameter to explain restriction for sending email
- Adds text explanations and links to supporting documentation of the introduction and parameter table
- Adds parameters:
RoleManager- Adds methods
ContentManagerclone_items()- Adds full support for StoryMap , WebScene, Survey123 and ExperienceBuilder items
- Ensures support for legacy ArcGIS Dashboards Classic items
- Adds keyword arguments description table:
- Adds option for keyword argument:
- copy_code_attachment
- Adds option for keyword argument:
add()- Enhances performance when updating file-base items with large files
import_data()- Improves performance by refactoring:
- methods into subpackage for cleaner processing
- refactoring private methods to use memory structures
- Improves performance by refactoring:
GroupManager- Adds methods:
Groupmigration- Adds hyperlink to GroupMigrationManager object returned by property
GroupMigrationManager- Adds text explanation and code snippet to initializer documentation
- Adds explanation, hyperlinks and code snippets for methods
Item- Adds link to full list of available properties in reference documentation
- Adds properties:
download()- Enhances performance on large downloads when authenticating through proxies
reassign_to()- Allows User object for the target_owner argument
update()- Enhances performance when updating file-base items with large files
- Updates code snippet to use correct object type
export()- Updates error reporting
- Fixes internal private methods to properly handle rest responses
share()- Updates documentation to clarify parameters
- Adds validation for
- input types before making calls to endpoints
- calling user privileges to ensure permissions are valid
arcgis.gis.admin
- Adds class documentation:
- For Organization interface:
- For ArcGIS Enterprise on Kubernetes
ExternalContentManagerLanguageManagerDataStoresDataStoreDeploymentJobJobManagerBackupBackupStoresManagerBackupStoreRecoveryManagerLicenseManagerLogManagerModeOverviewKubeEnterpriseGroupsKubeEnterpriseUserKubeOrganizationKubeOrganizationsKubeOrgFederationsKubeOrgLicenseKubeOrgSecurityKubeSecurityKubeSecurityCertKubeSecurityConfigKubeSecurityIngressKubeSecuritySAMLKubeServiceGPJobManagerServicesManagerContainerIndexerServerServerDefaultsServerManagerSystemManagerTaskManagerUpgradeManagerUploadsUsageStatistics
- For querying statistics about ArcGIS Online managed datastores:
Licenseassign()- Adds support for User object for the username argument
AGOLAdminManager- Adds properties:
UX- Adds methods:
arcgis.gis.server
Service- Adds support for new datatypes:
- esriFieldTypeBigInteger
- esriFieldTypeTimeOnly
- esriFieldTypeDateOnly
- esriFieldTypeTimestampOffset
- Adds support for new datatypes:
arcgis.gis.nb
SystemManagerproperties- Updates reference documentation
arcgis.gis.workflowmanager
- Adds ability to set a job version using an existing version
- Adds support for ArcGIS Online for better url discovery mechanism
WorkflowManagerAdmin- Adds methods:
JobManagerupdate()- Updates code snippet
arcgis.features
- Adds Class documentation:
- Adds support for TimeDelta and TimeStamp with TimeZone columns to:
- to_table()
- to_featureclass()
GeoAccessor(Spatially Enabled DataFrame)- Adds methods:
compare()- Based on Public Repo Issue #1445
- Adds capability to compare equality between two instances
to_featureclass()- Public Repo Issue #1494 - adds processing to replace NA types to None before conversions in
arcpyenvironments - adds ability to overwrite
- Public Repo Issue #1494 - adds processing to replace NA types to None before conversions in
- Adds methods:
GeoSeriesAccessor- Adds ability to compare two row values for a particular column
FeatureSet- Adds TimeDelta support
FeatureLayerquery_analytics()- Updates parameter table formatting for out_analytics
arcgis.features.manage_data
generate_tesselation()- Adds bin_resolution parameter
arcgis.features.managers
FeatureLayerCollectionManager- Adds methods:
create_view()- Adds warning that the overwrite argument is not supported
ParcelFabricManagerdivide()- Adds ability to run asynchronously
UtilityNetworkManagertrace()- Adds parameter:
- pbf
- Adds parameter:
arcgis.raster
- Adds support for more STAC datasets through existing methods in the module, notably Earth Search and Planetary computer, and Sentinel Hub STAC APIs:
ImageryLayer- Adds methods:
RasterCollection- Adds new methods:
arcgis.raster.analytics
- Adds functions:
- Allow aggregation functions (such as max(), mean(), sum(), etc) to accept RasterCollection object as input
- Enhances following functions to support ECD items
create_image_collection()- Adds ability to use RasterCollection objects for the input_rasters argument
arcgis.raster.functions
- Adds functions:
complex()- Adds parameters:
- imaginary_raster
- value_type
- Adds parameters:
arcgis.raster.orthomapping
arcgis.raster.utils
- Adds support for using FeatureLayer objects as input for mask environment parameters
arcgis.geocoding
- Adds class, enumeration, and function to support the beta Places service
arcgis.geoenrichment
- Adds verification for necessary capabilities when using functionality only available with specific versions
create_report()- Adds error handling
enrich()- Adds parameter:
- sanitize_columns
- Adds parameter:
arcgis.geometry
Geometryconvex_hull()- Adds support for MultiPoint geometry
- Updates documentation with formatting information for parameter arguments
arcgis.graph
apply_edits()- Adds note about supported values for input dictionaries
arcgis.mapping
- Working with 2D Maps
WebMap- Adds support for using secure service layers in
operationalLayersof the definition
- Adds support for using secure service layers in
arcgis.realtime
StreamLayersubscribe()- Raises error when incorrect packages are missing
arcgis.widgets
MapView- Adds check to ensure organization's custom basemap's settings are compatible with Map Viewer
arcgis.apps
- Adds submodule:
expbuilder- Adds ability to work with Experience Builder items using the API
storymap
arcgis.learn
- Data Preparation Methods
- Adds:
prepare_data()- Modify function to to accept a list of images to enable mixed-data training
prepare_tabulardata()- Adds
listas option for variable_predict argument to support multivariate and multiple timestep output for TimeSeries models - Adds keyword parameter for adding a validation set:
- random_split
- Adds
- Automated Machine Learning
AutoML- Adds support for training image, tabular, and text data together
- Adds keyword arguments table for initializing with these options:
- sensitive_variables
- fairness_metric
- fairness_threshold
- privileged_groups
- unprivileged_groups
- Object Classification Models
FeatureClassifier- Adds method to report on supported transformer backbones for model:
- Integrates transformer models
- Object Detection Models
EfficientDET- Adds support information for the data argument
- Image Translation Models
Pix2Pix- Enhances generation by adding backbone support
SuperResolution- Adds support for multispectral imagery
- Adds support for SR3 backbone
- 3d Models
- Adds model:
- Feature, Tabular, anad Timeseries models
TimeSeriesModel- Adds support for LSTM architecture
- Adds support for batch processing to increase processing speed when using LSTM
- Unstructured Text Models
- arcgis.learn.text module
TextClassifierpredict()- Adds batch_size parameter to support batch inferencing
SequenceToSequencepredict()- Integrates SHAP by introducing new keyword parameters:
- explain
- explain_index
- Integrates SHAP by introducing new keyword parameters:
- InferenceOnlyModels
QuestionAnsweringget_answer()- Enable SHAP with new keyword parameters:
- explain
- explain_start_word
- explain_index
- Enable SHAP with new keyword parameters:
- arcgis.learn.text module
Fixes
- Fixes BUG-000155321 where using
pipto install API led to incorrect version ofipywidgetsdependency - Fixes issue with arcgis.gis.admin module improperly loading when installing with
pipon non-Windows machines
Guides
- Layers
- Parcel Fabric
- Updates to guides to show return values of version properties
- Parcel Fabric
- Geocoding
- Batch Geocoding
- Adds examples of using analyze_geocode_input()
- Batch Geocoding
- Spatial Analysis
- Feature Analysis
- Updates data and filtering for better visualization in Summarizing feature data
- Feature Analysis
- Deep Learning
- 2D Computer Vision
- Other Imagery Topics
- Enhancements to How AutoDL Works
- Other Imagery Topics
- 2D Computer Vision
- Offline
- Updates to explanations and code in Managing offline map areas
- Administration
- Updates to code and explanations in Managing and accessing groups
- Updates Managing and accessing users to reflect user_types and New Member Defaults
- Content Management
- Updates Distributed Collaborations to reflect required order of organizations
Samples
- Org Administrators
- Deprecates Clone StoryMap version 2 as
clone_items()method now supports StoryMap items
- Deprecates Clone StoryMap version 2 as
- GIS analysts and data scientists
- Updates data for How much green is Delhi as on 13 Oct 2022?
- Updates for Data Summarization - Construction permits, part 2/2
- Detecting Super Blooms Using Satellite Image Classification
- Adds note about displaying Sentinel-2 image and new section for _Downloading and Visualization via SentinelHub API
- Deep Learning
- Content Publishers
- Updates data and adds publishing to Using and updating GIS content
Module Changes
arcgis.gis
GIS- Improves support for Multi-IWA authentication
- Fixes issue when expiration argument not getting applied if internal variables not set
Item- Fixes
General Exceptionerror when accessing the layers property for Multi-IWA authenticated Web GIS update()- Fixes issue where access key in
item_propertiesfailed to update
- Fixes issue where access key in
copy_item()- Fixes issue where tags doesn't properly format when entered as a list
- Fixes issue in Jupyter Notebooks where item types did not display with proper icons
add_comment()- Fixes BUG-000156789
Too many failureserror message when using method in ArcGIS Notebooks
- Fixes BUG-000156789
- Fixes
ContentManageradd()- Fixes issue where access key in
item_propertiesfailed to get added properly - Fixes
builtins.KeyError: 'privateUrl'error on ArcGIS Enterprise for Kubernetes
- Fixes issue where access key in
clone_items()- Fixes BUG-000150518 where Web App Builder application fails to clone between 10.9 and 10.9.1 Enterprise organizations
- Fixes BUG-000158101 where cloning from ArcGIS Online to Enterprise configured for IWA authentication failed with
Exception: a general error - Fixes
KeyError: 'owner'when cloning Web Map items with specific content - Fixes handling of Esri-owned content which should not be cloned between organizations
- Fixes BUG-000160370 where ArcGIS Solutions Citizen Problem Reporter or Problem Manager applications failed to clone
delete_items()- Public Repo Issue #1572 Fixes issue where org_admin users were not able to delete others' items
search()- ENH-000159413 Fixes documentation and messaging issue and adds link to authoritative source when results contain more than 10,000 items
import_data()- Fixes Public Repo Issue #1658 where MissingSchema error raised when mapping address to country or subnational area
GroupFixes issue where administrator could not operate methodnotify()- Updates code snippet to properly reflect input required for users argument
GroupManagercreate()- Fixes failure when membership_access argument is provided as None
Layerfrom_item()- Corrects input types accepted for the item argument
UserManagerorg_search()- Public Repo Issue #1500 - fixes issue where permissions error was returned instead of 0 when logged in anonymously
assign_categories()- Fixes formatting issue so assignment displays and filters properly when viewing users in browser interface
create()- Fixes error if default groups are set in the organization's default settings
- Fixes
NoneTypeerror if role argument not provided and New Member Defaults not set
PortalDataStoreregister()- Updates text_param argument syntax in the code snippet to correct punctuation for boolean value
publish_layers()- Removed documentation specifying method could run asynchronously
arcgis.gis.admin
AGOLUsageReportsgenerate_report()- Updates documentation for:
- supported report_type options
- duration argument to specify requirements
- specific requirements of the start_time argument
- Updates documentation for:
KubernetesAdmin- Fixes issue where certificate manager failed to load (gis.admin.security.certificates)
UX- Fixes issues when None or empty stings passed in as arguments for some settings
featured_content- Fixes bug where
Exceptionraised when trying to set a specific group
- Fixes bug where
summary- Fixes failure when calling on new Enterprise organizations
set_banner()- Fixes issue where enumeration values did not appear in parameter table
KubeServiceDirectorypublish_sd()- Fixes issue where incorrectly formatted service_config was being passed
arcgis.gis.server
- Fixes issue where objects authenticated with MultiIWA were not handling servers properly
Server- Fixes
UnboundLocalErrorwhen folder argument is a folder that does not exist: publish_sd()- Fixes issue where update of configuration not occurring properly
- Fixes
arcgis.gis.nb
NotebookServerhealth_check- Fixes issue where
SSLErrorreturned because of improperly formatted internal method
- Fixes issue where
arcgis.gis.workflowmanager
WorkflowManager- Fixes import module syntax in code snippet
arcgis.gis.tasks
TaskManagercreate()- Updates documentation with missing explanation and options for the task_type parameter
Taskupdate()- Updates documentation with missing explanation and options for the task_type parameter
arcgis.features
FeatureLayeredit_features()- Fixes failure when passing in FeatureSet as the argument because it passed empty geometry
query()- Fixes BUG-000159109 where results are not ordered correctly if both order_by_fields and return_all_records arguments are provided
Spatially Enabled DataFrame(GeoAccessor)- Public Repo Issue #1489 - Fixes
AttributeError module 'numpy' has not attribute 'int'with conversion methods- methods that begin with string: to*
from_parquet()- Updates parameter table and code snippets
to_featureclass()- Fixes issue where python[string] columns caused failure
to_table()- Fixes issue where sanitize_columns argument doesn't correct invalid column names
insert_layer()- Fixes
FileExistsErrorissue when temporary processing files are not cleaned up properly
- Fixes
from_df()- Fixes Public Repo Issue #1646 where rows are truncated from result if the number of rows exceeds the geocoder's MaxBatchSize property
- Public Repo Issue #1489 - Fixes
GeoSeriesAccessor(geomnamespace onSHAPEcolumn)angle_distance_to()- Deprecates PRESERVE_SHAPE option for
methodargument
- Deprecates PRESERVE_SHAPE option for
intersect()- Public Repo Issue #1575 Fixes issue where method returned True for non-intersection geometries
FeatureSetfrom_dataframe()- Fixes issue where NULL values in string fields prevented proper conversion
Tableedit_features()- Fixes
Exception 'orient' record not understooderror when using a GeoAccessor object as input
- Fixes
arcgis.features.managers
FeatureLayerCollectionManagercreate_view()- Fixes Public Repo Issue #1523 issue where
tagargument was overwritten by source item tags - Fixes BUG-000137640 where invalid characters in name where not raising errors
- Fixes Public Repo Issue #1523 issue where
overwrite()- Fixes Public Repo Issue #1601 where method failed with
ConnectionErroron ArcGIS Enterprise for Kubernetes
- Fixes Public Repo Issue #1601 where method failed with
SyncManagercleanup_change_tracking()- Fixes BUG-000152080 where layers argument passed incorrectly leading to Server 400 error
AttachmentManagersearch()- Fixes issue where maxRecordCount value returned instead of all records by default
download()- Corrects parameter name in documentation from save_folder to save_path
arcgis.features.manage_data
generate_tesselation()- Fixes
TypeErrorbecause internal function returns None for bin_resolution value
- Fixes
arcgis.raster
Rasterexport_image()- Fixes
ValueErrormessage when exporting locally even though method functions properly
- Fixes
ImageryLayer- Ensure that 64-bit integer values are handled correctly because of improper datetime handling
query()- Fixes incorrect output returned if time_filter argument is a datetime.date object
arcgis.raster.analytics
generate_raster()- Fixes issue where output remained constant because of mosaic rule configuration
convert_raster_to_features()- Correct return value in reference documentation
copy_raster()- Fixes
Failed to executeerror because of improper handling if token not present in token-based authentication
- Fixes
arcgis.raster.functions.RFT
- Fixes issue with incorrect rendering when RFT module is used on a layer
arcgis.geocoding
geocode()- Fixes issue where out_sr argument is not honored on output
batch_geocode()- Fixes Public Repo Issue #1650 issue where function returns FeatureSet with no geometries if any input addresses are empty strings
arcgis.geoenrichment
create_report()- Fixes issue where error reported incorrectly when point geometry used as study_area with out_name argument
enrich()- Fixes
Attribute_Errorwhen using analysis_variables argument - Fixes
Exception: Unable to complete operationerror when using an extent object as study_area argument - Fixes issue where study_area defined with Walking travel mode does not get correctly enriched
- Fixes failure when study_areas argument is a Polygon passed in as a dictionary
- Fixes
Country()enrich()- Fixes method to ensure extent, list of BufferStudyArea, Geometry, and GeoAccessor objects are accepted as input
arcgis.geometry
Geometry- Fixes output response and spatial_reference input formats using Geometry Service for:
arcgis.mapping
- Working with 2D Maps
WebMapgallery_basemaps- Fixes issue where property is not honoring value that should be returned based on group setting
basemaps- Fixes issue where same value returned whether user is authenticated or not
save()- Public Repo Issue #1484 and BUG-000156142 Fixes issue with tiles only ImageryLayer not appearing in saved Web Map
- Working with Map Service Layers
MapImageLayer- Fixes internal processing methods to configure urls properly for:
arcgis.widgets
MapView- Fixes BUG-000157292 where
gis.map()failed to authenticate when run in Enterprise notebooks add_layer()- Fixes visualization issue when
opacityis in options argument - Fixes
ValueErrorwhen adding output from geocoding (input passed in as a dictionary)
- Fixes visualization issue when
zoom_to_layer()- Fixes issue where method would not work on MapImageLayer or MapRasterLayer objects
- Fixes BUG-000157292 where
arcgis.apps
storymapStorymapMapset_viewpoint()- enhance scale argument to accept dictionary for custom scales
survey123generate_report()- Updates reference documentation with more explanation and code snippets
Survey- Fixes issue when initializing object with relate FeatureService with non-zero layer indexing
hubHub- Adds GIS parameter to replace username and password for initialization
SiteManagerInitiativeManager
arcgis.learn
- Fixes GPU utilization during CPU training for multiple models:
- PSETAE, FeatureClassifier, SuperResolution, ImageCaptioner, Pix2PixHD
- Fixes issue with per_class_metrics() method returning all classes even when setting ignore_classes argument
- Data Preparation Methods
prepare_tabulardata()- Fixes error when both explanatory_variables and explanatory_rasters arguments are provided
- Fixes issue when using preprocessors argument where explanatory_variables cannot be passed without using transformation
- Fixes error for MascRCNN output when exported data contains white space in the class_value key
- Automated Machine Learning
AutoML- Fixes bug when initializing with fairness_metric keyword argument
predict()- Fixes incorrect results because of application of fit_transforms instead of transforms during training
- Fixes issue during training when using mixed data containing images
- Fixes
UnboundLocalErrorwhen using data argument prepared with explanatory_variables and variable_predict - Fixes
NameErrorwhen using multiclass classification fairness_score()- Fixes
ValueErrorwhen using sensitive_feature and visualize arguments
- Fixes
- Object Classification Models
FeatureClassifier- Fixes
RuntimeErrorwhen using timm backbone - Fixes
NameErroron show_batch() when number of rows exceeds number used to train data
- Fixes
- Object Detection Models
- Fixes errors when initializing modles with specific backbones
MaskRCNN- Fixes issue where invalid JSON including NaN in the average precision returned on successful model training
fit()- Fixes issue where inferencing giving output of 0 length or Null geometries
MMDetection- Fixes issue
URLErrorwhen initializing with fcos model
- Fixes issue
EfficientDET- Fixes failure on initializing when labels directory contains non-file types
save()- Adds missing metric information to appropriate files for average_precision_score information
- Pixel Classification Models
ChangeDetectorpredict()- Fixes
AttributeError _EmptyDataerror when run from model initialized with a saved dlpk file
- Fixes
MaXDeepLabcompute_n_masks()- Fixes issue where returns value of 0 when run in Linux environment
- Image Translation Models
Pix2Pix- Fixes
AttributeErrorissue with initializing on outdated datasets
- Fixes
Pix2PixHDcompute_metrics()- Fixes visualization issue when model trained with DSM (1 band) to RGB (3 band) data and per_class_metrics()
SuperResolutionfrom_model()- Fixes
RuntimeError in loading state_dicterror when using on Linux platforms
- Fixes
- Feature, Tabular, anad Timeseries models
- Fixes
TypeErroron show_results() because of incorrect input format on internal functions PSETAE- Fixes incorrect initialization of model when using prepare_data() output prepared with channels_of_interest or classes_of_interest arguments
- Fixes
- Unstructured Text Models
- Fixes import errors when trying to import submodule on Ubuntu systems
- arcgis.learn.text module
TextClassifier- Fixes issue where wrong confidence value was returned if batch_size was greater than 1
- Inferencing Methods
detect_objects- Fixes error if the tile size varies while inferencing
- Model Management
ModelExtension- Fixes
AttributeErrorfailure for stand alone models on:save()- per_class_metrics()
- Fixes