H2O Steam

h2osteam

class h2osteam.h2osteam.AutoDocConfig(template_path=None, template_sections_path=None, sub_template_type=None, main_template_type='docx', float_format='{:6.4g}', data_summary_feat_num=- 1, num_features=20, plot_num_features=20, min_relative_importance=0, stats_quantiles=20, psi_quantiles=10, response_rate_quantiles=10, pdp_feature_list=None, mli_frame=None, ice_frame=None, num_ice_rows=0, cardinality_limit=25, pdp_out_of_range=3, pdp_num_bins=10, warning_shift_auc_threshold=0.8, include_hist=True, use_shapley=True, **kwargs)
serialize()
h2osteam.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.h2osteam.login(url=None, username=None, password=None, verify_ssl=True, cacert=None)

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.

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 or user access token of the connecting user.

  • verify_ssl – Setting this to False will disable SSL certificates verification.

  • cacert – Path to a CA bundle file or a directory with certificates of trusted CAs (optional).

Examples

>>> import h2osteam
>>> url = "https://steam.example.com:9555"
>>> username = "AzureDiamond"
>>> password = "hunter2"
>>> h2osteam.login(url=url, username=username, password=password, verify_ssl=True)
h2osteam.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.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