Server

Server

The connected Driverless AI server.

Example

client = driverlessai.Client(
    address="http://localhost:12345",
    username="py",
    password="py",
)

client.server.address
client.server.username
client.server.version

address property

address: str

URL of the Driverless AI server.

Returns:

• str –

   

configurations property

configurations: dict[str, Any]

Exposed configurations of the Driverless AI server.

Returns:

• dict[str, Any] –

  Exposed server configurations to the client.

cpu_usages property

cpu_usages: list[float]

CPU usage statistics of the Driverless AI server.

Returns:

• list[float] –

  A list of CPU usage percentages for each CPU core.

Driverless AI version requirement

Requires Driverless AI server 1.10.6 or higher.

Beta API

A beta API that is subject to future changes.

disk_usage property

disk_usage: dict[str, int]

Disk usage statistics of the Driverless AI server.

Returns:

• dict[str, int] –

  A dictionary with keys total, available, and used, representing the respective disk space in bytes.

experiment_stats property

experiment_stats: dict[str, int]

Experiments-related statistics of the Driverless AI server.

Returns:

• dict[str, int] –

  A dictionary with keys total, my_experiments_total, my_experiments_running, containing the total number of experiments, total number of the user's experiments, and the number of the user's currently running experiments.

gpu_usages property

gpu_usages: list[dict[str, float]]

GPU usage statistics of the Driverless AI server.

Returns:

• list[dict[str, float]] –

  A list of dictionaries, each containing memory and usage keys with corresponding GPU memory in bytes and usage.

license property

license: License

License of the Driverless AI server.

Returns:

• License –

   

memory_usage property

memory_usage: dict[str, int]

Memory usage statistics of the Driverless AI server.

Returns:

• dict[str, int] –

  A dictionary with keys total, available, and used, representing the respective memory space in bytes.

Driverless AI version requirement

Requires Driverless AI server 1.10.6 or higher.

storage_enabled property

storage_enabled: bool

Whether the Driverless AI server is connected to H2O.ai Storage or not.

Returns:

• bool –

   

username property

username: str

Name the current user connected to the Driverless AI server.

Returns:

• str –

   

version property

version: Version

Version of the Driverless AI server.

Returns:

• Version –

   

workers property

workers: list[dict[str, Any]]

Statistics for each worker node of the Driverless AI server.

Returns:

• list[dict[str, Any]] –

  A list of dictionaries, each representing a worker node with details such as name, health status, IP address, number of GPUs, and other relevant metrics.

Beta API

A beta API that is subject to future changes.

docs

docs(search: str = None) -> Hyperlink

Returns the full URL to the Driverless AI documentation.

Parameters:

• search (str, default: None ) –

  A query to search in docs. If provided, the hyperlink will point to the search results page.

Example

# Search the DAI docs for "experiments"
client.server.docs(search="experiments")

gui

gui() -> Hyperlink

Returns the full URL to the Driverless AI server web UI.

Returns:

• Hyperlink –

  URL to the web UI.

License

License of the Driverless AI server.

days_left

days_left() -> int

Returns the remaining number of days until license expiration.

is_valid

is_valid() -> bool

Whether the license is valid and not-expired.

Version

A version of H2O Driverless AI. Compatible with ==, !=, <, <=, >, >= operators.

Example: Comparing the Driverless AI server version

client.server.version == "1.10.5"

client.server.version < "1.10.5"

client.server.version > "1.10.5"

major property

major: int

The first part of the version or 0 if unavailable.

Examples:

>>> Version("1.10.5.1").major
1

Returns:

• int –

   

micro property

micro: int

The third part of the version or 0 if unavailable.

Examples:

>>> Version("1.10.5.1").micro
5

Returns:

• int –

   

minor property

minor: int

The second part of the version or 0 if unavailable.

Examples:

>>> Version("1.10.5.1").minor
10

Returns:

• int –

   

patch property

patch: int

The forth part of the version or 0 if unavailable.

Examples:

>>> Version("1.10.5.1").patch
1

Returns:

• int –