h2osteam¶

class h2osteam.SteamClient(conn=None)¶

DEPRECATED! This class and its methods are deprecated and they will be removed in v1.9

create_pyspark_python_path_environment(name, path)¶: DEPRECATED! Create Python Pyspark Path environment.

delete_python_environment(environment_id)¶: DEPRECATED! Delete Python environment.

static get_h2o_cluster(cluster_name)¶: DEPRECATED! Get H2O cluster by name.

get_h2o_clusters()¶: DEPRECATED! Get H2O clusters.

get_python_environments()¶: DEPRECATED! Get Python environments.

static get_sparkling_cluster(cluster_name)¶: DEPRECATED! Get Sparkling Water cluster by name.

get_sparkling_clusters()¶: DEPRECATED! Get Sparkling Water clusters.

static show_profiles()¶: DEPRECATED! Prints profiles available to this user.

static start_external_sparkling_cluster(cluster_name=None, profile_name=None, h2o_version=None, driver_cores=0, driver_memory_gb=0, num_executors=0, executor_cores=0, executor_memory_gb=0, h2o_nodes=0, h2o_node_memory_gb=0, h2o_node_threads=0, start_timeout_sec=0, yarn_queue=None, python_environment_name='', spark_properties=None)¶: DEPRECATED! Launch Sparkling Water external backend cluster.

static start_h2o_cluster(cluster_name=None, profile_name=None, num_nodes=0, node_memory=None, v_cores=0, n_threads=0, max_idle_time=0, max_uptime=0, extramempercent=10, h2o_version=None, yarn_queue=None, callback_ip=None, node_id=0)¶: DEPRECATED! Launch a new H2O cluster.

static start_internal_sparkling_cluster(cluster_name=None, profile_name=None, h2o_version=None, driver_cores=0, driver_memory_gb=0, num_executors=0, executor_cores=0, executor_memory_gb=0, h2o_node_threads=0, start_timeout_sec=0, yarn_queue=None, python_environment_name='', spark_properties=None)¶: DEPRECATED! Launch Sparkling Water internal backend cluster.

static stop_h2o_cluster(config)¶: DEPRECATED! Stop H2O cluster.

static upload_conda_environment(name, path)¶: DEPRECATED! Upload Conda Python environments.

static upload_engine(path)¶: DEPRECATED! Upload H2O engine.

static upload_sparkling_engine(path)¶: DEPRECATED! Upload Sparkling Water engine.

h2osteam.api()¶

Get direct access to the Steam API for expert users only.

Expert users can bypass the clients for each product and access the Steam API directly. This use-case is not supported and not recommended! If possible use the provided clients!

Examples

>>> import h2osteam
>>> h2osteam.login(url="https://steam.h2o.ai:9555", username="user01", password="token-here", verify_ssl=True)
>>> api = h2osteam.api()
>>> api

h2osteam.login(url=None, username=None, password=None, verify_ssl=True, cacert=None, access_token='', refresh_token='', no_proxy=True)¶

Connect to an existing Enterprise Server server.

There are two ways to pass password to a server: either pass a server parameter containing an instance of an H2OLocalServer, or specify ip and port of the server that you want to connect to.

You may pass either OpenID access or refresh token. Refresh token is recommended.

Parameters

url – Full URL (including schema and port) of the Steam server to connect to. Must use https schema.
username – Username of the connecting user.
password – Password of the connecting user or access token.
verify_ssl – Setting this to False will disable SSL certificates verification.
cacert – (Optional) Path to a CA bundle file or a directory with certificates of trusted CAs.
access_token – Access token
refresh_token – OpenID refresh token
no_proxy – If True, sets or appends environmental variables no_proxy and NO_PROXY with Steam hostname

before doing any network requests.

Examples

>>> import h2osteam
>>> url = "https://steam.example.com:9555"
>>> username = "AzureDiamond"
>>> password = "hunter2"
>>> h2osteam.login(url=url, username=username, password=password, verify_ssl=True)
>>> # or using an access token retrieved from the Web Client
>>> h2osteam.login(url="https://steam.example.com:9555", access_token="SyzjffQAcYgz6Nk...")
>>> # or using a refresh token
>>> h2osteam.login(url="https://steam.example.com:9555", refresh_token="KdO2KdntsON9a...")

h2osteam.print_profiles()¶

Prints profiles available to this user.

Prints details about the profiles available to the logged-in user.

Examples

>>> import h2osteam
>>> h2osteam.login(url="https://steam.h2o.ai:9555", username="user01", password="token-here", verify_ssl=True)
>>> h2osteam.print_profiles()
>>> # Profile name: default-h2o
>>> # Profile type: h2o
>>> # Number of nodes: MIN=1 MAX=10
>>> # Node memory [GB]: MIN=1 MAX=30
>>> # Threads per node: MIN=0 MAX=0
>>> # Extra memory [%]: MIN=10 MAX=50
>>> # Max idle time [hrs]: MIN=1 MAX=24
>>> # Max uptime [hrs]: MIN=1 MAX=24
>>> # YARN virtual cores: MIN=0 MAX=0
>>> # YARN queues:

h2osteam.print_python_environments()¶

Prints Sparkling Water Python environments available to this user.

Prints details about Sparkling Water Python environments available to the logged-in user.

Examples

>>> import h2osteam
>>> h2osteam.login(url="https://steam.h2o.ai:9555", username="user01", password="token-here", verify_ssl=True)
>>> h2osteam.print_python_environments()
>>> # Name: Python 2.7 default
>>> # Python Pyspark Path:
>>> # Conda Pack path: lib/conda-pack/python-27-default.tar.gz
>>> # ===
>>> # Name: Python 3.7 default
>>> # Python Pyspark Path:
>>> # Conda Pack path: lib/conda-pack/python-37-default.tar.gz

h2osteam.set_license(path=None, text=None)¶

Sets (or updates) Enterprise Steam license. The license can be provided either by specifying a path to a license file or providing license text in respective parameters.

Parameters

path – Path to a license file.
text – License text. Ignored if path is provided.

Examples

>>> import h2osteam
>>> h2osteam.login(url="https://steam.h2o.ai:9555", username="admin_user", password="token-here", verify_ssl=True)
>>> h2osteam.set_license(path="/user/admin/license.sig")
>>> # Or provide license text directly
>>> h2osteam.set_license(text='''
>>> license text...
>>> ''')