Python Client

v5.2.1 [2023-01-10]

Changes

• Breaking Change!
  • Version 5.2.1 holds major breaking changes from the previous version. All previous capabilities are available in a different format under similar but changed methods.
• Complete redesign of the client.
  • 1st level direct access to API endpoints.
  • 2nd level function methods to facilitate MLOps.
  • Helper functions for pre- and postprocessing data.

New features

• 1st level endpoint methods
  • user_group
    • list_user_group
    • create_user_group
    • details_user_group
    • update_user_group
    • delete_user_group
  • workspaces
    • list_workspace
    • create_workspace
    • details_workspace
    • edit_workspace
    • delete_workspace
  • datasets
    • upload_dataset
    • update_dataset
    • list_dataset
    • delete_dataset_list
    • details_dataset
    • edit_dataset_details
    • delete_dataset
    • dataset_logs
    • logs_dataset_version
    • list_dataset_versions
    • details_dataset_version
    • delete_dataset_version
    • status_dataset_version
  • use_cases
    • list_use_case
    • create_use_case
    • details_use_case
    • edit_use_case
    • delete_use_case
  • experiments
    • list_experiment
    • create_experiment
    • details_experiment
    • edit_experiment
    • delete_experiment
  • forecasting
    • build_model
    • upload_model
    • rebuild_model
    • retrain_model
    • predict
    • rca
    • what_if
    • job_list
    • delete_job_list
    • job_details
    • delete_job
    • copy_job
    • execute
    • job_logs
    • status
    • status_collect
    • results_table
    • results_production_forecast
    • results_model
    • results_accuracies
    • results_rca
    • results_production_table
    • results_production_accuracies
  • detection
    • build_kpi_model
    • build_system_model
    • upload_model
    • rebuild_kpi_model
    • detect
    • rca
    • what_if
    • jobs_list
    • delete_job_list
    • job_details
    • delete_job
    • copy_job
    • execute
    • job_logs
    • status
    • status_collect
    • results_table
    • results_model
    • results_accuracies
    • results_rca
    • results_production_table
    • results_production_accuracies
  • licenses
    • details_license
    • storage_license
  • telemetry
    • dataset_calls
    • job_calls
• 2nd level function methods
  • datasets
    • poll_dataset_version_status
    • upload_dataset
    • update_dataset
  • forecasting
    • poll_forecast_status
    • forecasting_job_results
    • execute_forecast_job
    • forecasting_build_model
    • forecasting_predict
    • forecasting_rebuild_model
    • forecasting_retrain_model
    • forecasting_results_rca
    • forecasting_root_cause_analysis
    • forecasting_what_if_analysis
    • quick_forecast
  • detection
    • poll_detect_status
    • detection_job_results
    • execute_detection_job
    • detection_build_kpi_model
    • detection_build_system_model
    • detection_rebuild_kpi_model
    • detection_detect
    • detection_results_rca
    • detection_root_cause_analysis
    • detection_what_if_analysis
• Helper functions
  • post_process
    • properties
    • features
    • forecast_accuracy_table

v5.1.1 [2022-05-06]

New features

• Dataset management interface
  • update_dataset
  • Added wait_to_finish parameter to upload_dataset

v5.1.0 [2022-04-05]

New features

• Forecasting interface
  • create_forecast
  • create_forecast_and_execute
  • rebuild_forecasting_model
  • rebuild_forecasting_model_and_execute
  • Added allowOffsets and offsetLimit parameters to the configuration of forecasting jobs of type build model
    • build_forecasting_model
    • build_forecasting_model_and_execute
    • clean_forecast
• Anomaly detection interface
  • rebuild_anomaly_detection_model
  • rebuild_anomaly_detection_model_and_execute

v5.0.3 [2022-01-26]

Changes

• Added a reference to the release notes in the listing description
• Updated the listing description to mention 'InstantML'

Bug fixes

• Fixed error on calling upload_dataset or clean_forecast multiple times in the same session
• Fixed docstrings:
  • Response of upload_dataset: dataset_metadata Dict instead of ID and Dict separately
  • Response of clean_forecast: forecasting_logs are returned before dataset_logs
  • Response of get_anomaly_detection_results: no accuracies are returned

v5.0.0 [2021-12-17]

New features

• Implements TIM API v5
• Dataset management interface
  • upload_dataset
  • delete_dataset
  • get_datasets
  • get_dataset_versions
• Forecasting interface
  • clean_forecast
  • build_forecasting_model
  • execute_forecast
  • build_forecasting_model_and_execute
  • get_forecast_results
  • get_forecasting_jobs
  • delete_forecast
• Anomaly detection interface
  • build_anomaly_detection_model
  • create_anomaly_detection
  • execute_anomaly_detection
  • build_anomaly_detection_model_and_execute
  • create_anomaly_detection_and_execute
  • get_anomaly_detection_results
  • get_anomaly_detection_jobs
  • delete_anomaly_detection
• Workflow management interface
  • get_workspaces

v1.0.0 [2020-04-24]

New features

• Prediction and anomaly detection interface
• Pandas Dataframe support
• Ability to load dataset from CSV file
• Implements TIM API v4