Python client history
3.x client version
3.1
3.1.0
-
New Features
- Introduced the native support for model versions.
- Optional
version
parameter added toModel
,Model.from_data
,Model.from_name
methods. - New
duplicate()
method to seamlessly create new version from existing model. - Optional
name
parameter added toModel.list
to offer the ability to list all the versions of a model.
- Optional
- Introduced the native support for model versions.
3.0
3.0.5
3.0.4
3.0.3
3.0.2
3.0.1
-
New Features
- General
- Moving all functions of client to an Object oriented approach
- Methods return resource object or a deserialised object wherever possible.
- Support to search model, project, dataset, baselines by their names using
from_name()
method. - List methods will return iterator which handles pagination internally.
- Data
- Concept of environments was introduced.
- Ability to download slice data to a parquet file.
- Publish dataframe as stream instead of batch.
- New methods for baselines.
- Multiple datasets can be added to a single model. Ability to choose which dataset to use for computing feature impact / importance, surrogate generation etc.
- Model can be added without dataset.
- Ability to generate schema for a model.
- Model delete is async and returns job details.
- Added cached properties for
model
:datasets
,model_deployment
.
- Alerts
- New methods for alerts:
enable_notification
,disable_notification
,set_notification_config
andget_notification_config
.
- New methods for alerts:
- Explainability
- New methods in explainability:
precompute_feature_impact
,precompute_feature_importance
,get_precomputed_feature_importance
,get_precomputed_feature_impact
,precompute_predictions
. - Decoupled model artifact / surrogate upload and feature impact / importance pre-computation.
- New methods in explainability:
- General
-
Modifications
- All IDs will be UUIDs instead of strings
- Dataset delete is not allowed anymore
2.x client version
2.5
2.5.3
2.5.2
2.5.1
2.5.0
-
New Features
- Add support for enrichments
- Allow pausing multiple alerts at once
- Add percentage violation metrics for alert
- Support for alert revisions
2.4
2.4.1
2.4.0
-
New Features
- Add support for segments
-
Modifications
- Ensure
TextEmbedding
andImageEmbedding
is supported for vectors in metadata
- Ensure
2.3
2.3.0
-
New Features
- Added support for creating alerts on the
Frequency
metric.
- Added support for creating alerts on the
-
Modifications
- Relax pydantic version to allow any version between 1.9 and 2
2.2
2.2.1
2.2.0
-
Modifications
- Method
add_custom_metric
supports an optionaldescription
parameter - parameter
fql
is renamed todefinition
inadd_custom_metric
method - A new
get_custom_metric
function to get details about a single custom metric.
- Method
2.1
2.1.2
2.1.1
2.1.0
-
New Features
- Introduce Model Tasks
NOT_SET
andLLM
- Relax Target / Output specification for model tasks
NOT_SET
andLLM
- Support custom metrics
-
Modifications
DatasetDataSource
andEventIdDataSource
will takedataset_id
instead ofdataset_name
- Method
list_baselines
to return baseline names instead of baseline objects
2.0
2.0.8
2.0.7
2.0.6
2.0.5
2.0.4
2.0.3
-
Modifications
- Relax pandas version for 2.0.
- In
get_slice
method, parameterquery
is reverted back tosql_query
2.0.2
2.0.1
-
Removed
- Following methods are removed
register_model
upload_model_package
update_model
trigger_pre_computation
_trigger_model_predictions
generate_sample_events
list_teams
list_project_roles
list_org_roles
unshare_project
share_project
process_avro
process_csv
- Following methods are removed
-
New Features
- Add
monitor_components
as an attribute forCustomFeature
of typeFROM_COLUMNS
. Default asFalse
- Adds new statistic type
SUM
to supported alert metrics - Support
CustomFeature
of typeFROM_VECTOR
FROM_TEXT_EMBEDDING
andFROM_IMAGE_EMBEDDING
- Add
-
Modificatiosn
- Remove
column
as a parameter inadd_alert_rule
andget_alert_rules
functions - Default
FileType
Parquet inupload_dataset
andpublish_event_batch
- In
get_slice
method,slice_query
parameter is changed toquery
- Remove
1.x client version
1.8
1.8.6
1.8.4
1.8.3
-
Modifications
- New
columns
parameter in add_alert_rule and get_alert_rules to support multiple columns to be used for server version >= 23.3.0 - get_triggered_alerts supports
alert_value
as a float as well as a dict
1.8.2
-
Modifications
- Fixed a bug where
min
andmax
for columns of typefloat
indataset_info
are cast intoint
after uploaded
- Fixed a bug where
1.8.1
-
Modifications
- Fixed a bug wherein null string was going in request body if body wasn't specified.
- Fix
categorical_target_class_details
when passed as an array - Fix a bug where
fdl.ModelInputType.TEXT
were not being accepted properly - Fix
categorical_target_class_details
when passed as an empty list
1.8.0
-
Modifications
- Add new alert type -
statistic
for setting alerts - Add
target_class_order
as a required field ofModelInfo
object whenmodel_task
isMULTICLASS_CLASSIFICATION
,
RANKING
orBINARY_CLASSIFICATION
. Only applies forBINARY_CLASSIFICATION
when target column is of typeCATEGORY
- Add
columns
as a parameter inadd_alert_rule
andget_alert_rules
functions - Add deprecation warning for
column
as a parameter inadd_alert_rule
andget_alert_rules
functions
- Add new alert type -
1.7
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
-
Removed
- Remove support for initializing fiddler client with version=1
- Following methods are removed
get_segment_info
delete_segment
deactivate_segment
activate_segment
list_segments
upload_segment
add_monitoring_config
publish_parquet_s3
publish_events_log
1.6
1.6.2
-
Modifications
- Make
dataset_id
a required field inadd_model
- Update
max_inferred_cardinality
to 100
- Make
-
New Features
- New method for updating a model artifact
update_model_artifact
- New method for updating a model artifact
1.5
1.5.3
-
Modifications
- Fix
add_model_artifact
error for NLP models - Add model info validation during
add_model
- Fix
1.5.2
1.5.1
1.5.0
-
New Features
- New methods addition for alert rules:
add_alert_rule
,get_alert_rules
,delete_alert_rule
- New method to get triggered alerts for an alert rule:
get_triggered_alerts
- New methods addition for alert rules:
Any version before 1.5 is deprecated.