Driverless AI Python Client

The Driverless AI Python client provides an API to easily interact with a Driverless AI server.

Supported Driverless AI Servers

The client version number indicates the most recent Driverless AI server supported by that specific client version. However, all client versions are backwards compatible with Driverless AI servers down to version 1.9.0. The following is a list of supported Driverless AI server versions:

• 1.9.0 - 1.9.3.3 (Deprecation warning: Support for version 1.9.x will be removed in the upcoming 1.10.7 release.)
• 1.10.0 - 1.10.6.2

Requirements

• python >=3.7,<3.12
• requests
• tabulate
• toml

Warning

Support for Python 3.7 will be dropped from v1.10.7 onwards.

Feature Support

The client does not currently support the following Driverless AI features:

• Diagnostics
• Deployments
• MLI BYOR (partial support)
• mTLS authentication
• Recipe management

If there are any features you’d like like to see in the client, please let us know at support@h2o.ai.

Additional Resources

• Driverless AI Documentation

Have Questions?

If you have questions about using Driverless AI, post them on the H2O.ai Community Slack workspace in the #driverless-ai channel. If you have not signed up for the H2O.ai Community Slack workspace, you can do so here: https://www.h2o.ai/community/.

Have Feedback?

Please send feedback to help improve the client and documentation to support@h2o.ai.

Table of Contents

Setup

• Install
  • pip
  • conda
• Update
  • pip
  • conda

Examples

• Getting Started
  • Connecting to a Server
  • Loading Data
  • Running an Experiment
• Datasets
  • Create Datasets
  • Dataset Column Details
• Visualizations
  • Connect to a server
  • Load data
  • Create visualizations
  • Add a custom plot
  • View a custom plot
  • Remove a custom plot
• Experiments
  • New Model with Same Parameters
  • Restart From Last Checkpoint
  • Retrain Final Pipeline
  • Search Expert Settings
  • Train an Unsupervised Model
  • Transform dataset using trained model
  • Use a Custom Model
  • Use a Custom Scorer
  • Use a Custom Transformer
• MLI
  • Access Explainer generated data
  • Run an interpretation
  • Run specific explainer
  • Use a Custom Explainer
• Projects
  • Create a Project
• Admin API
  • Loading all users
  • Loading all currently logged in users
  • List the datasets of a specified user
  • List the experiments of a specified user
  • Transfer data between users
• Model Diagnostics
  • Experiment
  • Test Dataset
  • Scores
  • Metric Plots
• AutoDoc
  • Interact with AutoDoc associated to an Experiment
  • Create a new AutoDoc for an experiment
• Connect to H2O AI Cloud
  • AI Engine Manager
  • Steam

API In Depth

• Client
  • Interact with Server Entities
  • Get Information about the Server
• Server Objects
  • Dataset
  • Experiment
  • Interpretation
  • Project
  • Recipe
  • Utility
  • Visualization
  • Admin API
  • Model Diagnostics
  • AutoDoc
  • Deployment
• Utilities
  • Server Check
  • Token Providers
• API stability levels
  • Stable
  • Beta

Misc.

• Concepts
  • create vs. create_async
  • server entity vs. server object
• Frequently Asked Questions
  • What Driverless AI server version does the client work with?
  • How can I avoid hardcoding my password?
  • How can I suppress InsecureRequestWarning messages when initializing the client with verify=False?
  • Why is verify=false ignored when initializing the client ?
  • Can I download to an external file system, such as s3?
• Changelog
  • [1.10.6.2] - 2023-11-01
  • [1.10.6.1] - 2023-09-04
  • [1.10.6] - 2023-08-28
  • [1.10.5.1] - 2023-08-15
  • [1.10.5.post1] - 2023-05-03
  • [1.10.5] - 2023-04-25
  • [1.10.4.3] - 2023-01-30
  • [1.10.4.2] - 2023-01-16
  • [1.10.4.1] - 2022-12-15
  • [1.10.4.post1] - 2022-11-01
  • [1.10.4] - 2022-10-25
  • [1.10.3.1] - 2022-06-16
  • [1.10.3] - 2022-05-03
  • [1.10.2] - 2022-02-22
  • [1.10.1.3] - 2022-01-10
  • [1.10.1.2] - 2021-12-23
  • [1.10.1.1] - 2021-12-15
  • [1.10.1.post1] - 2021-12-06
  • [1.10.1] - 2021-11-12
  • [1.10.0] - 2021-09-30
  • [1.9.3.1] - 2021-08-12
  • [1.9.3] - 2021-06-02
  • [1.9.2.1.post1] - 2021-05-05
  • [1.9.2.1] - 2021-04-05
  • [1.9.1.1] - 2021-02-24
  • [1.9.1.post1] - 2021-01-25
  • [1.9.1] - 2021-01-19
  • [1.9.0.6] - 2021-01-06
  • [1.9.0.5] - 2020-12-21
  • [1.9.0.4.post2] - 2020-12-02
  • [1.9.0.4.post1] - 2020-11-16
  • [1.9.0.4] - 2020-10-23
  • [1.9.0.3] - 2020-10-09
  • [1.9.0.2.post2] - 2020-09-28
  • [1.9.0.2.post1] - 2020-09-24
  • [1.9.0.2] - 2020-09-17
  • [1.9.0.1] - 2020-08-14
  • [1.8.7.2.post1] - 2020-07-17
  • [1.8.7.2] - 2020-07-17
  • [1.8.7.1-beta-0] - 2020-07-06
  • [1.8.7-beta-0] - 2020-06-23
  • [1.8.6.3-beta-1] - 2020-06-08
  • [1.8.6.3-beta-0] - 2020-05-29
  • [1.8.5.1-beta-0] - 2020-04-10
  • [1.8.4.1-beta-1] - 2020-03-17
  • [1.8.4.1-beta-0] - 2020-03-06