CLI library to automate the onboarding process to IBM AI OpenScale
Project description
This tool allows user to get started real quick by exploring the environment to understand what user has, and then provision corresponding services needed to run AI OpenScale, then setup the models and setup monitoring conditions.
Before you begin
☁️ You need an IBM Cloud account.
🔑 Create an IBM Cloud API key
⚠️ If you already have a Watson Machine Learning (WML) instance, ensure it’s RC-enabled, learn more about this in the migration instructions.
Installation
To install, use pip or easy_install:
pip install -U ibm-ai-openscale-cli
or
easy_install -U ibm-ai-openscale-cli
️️ ## Usage
ibm-ai-openscale-cli --help
usage: ibm-ai-openscale-cli [-h] -a APIKEY [--env {ypprod,icp}] [--resource-group RESOURCE_GROUP] [--organization ORGANIZATION] [--space SPACE] [--postgres POSTGRES] [--db2 DB2] [--wml WML] [--username USERNAME] [--password PASSWORD] [--url URL] [--datamart-name DATAMART_NAME] [--history HISTORY] [--bx] [--verbose] [--version] optional arguments: -h, --help show this help message and exit --env {ypprod,icp} Environment. Default "ypprod" --resource-group RESOURCE_GROUP Resource Group to use. If not specified, then "default" group is used --organization ORGANIZATION Cloud Foundry Organization to use --space SPACE Cloud Foundry Space to use --postgres POSTGRES Path to postgres credentials file. If not specified, then the internal AIOS database is used --db2 DB2 Path to db2 credentials file --wml WML Path to WML credentials file --username USERNAME ICP username. Required if "icp" environment is chosen --password PASSWORD ICP password. Required if "icp" environment is chosen --url URL ICP url. Required if "icp" environment is chosen --datamart-name DATAMART_NAME Specify data mart name, default is "aiosfastpath" --history HISTORY Days of history to preload. Default is 7 --bx Specify (without a value) to use IBM Cloud CLI (bx CLI), default uses Rest API --verbose verbose flag --version show program's version number and exit required arguments: -a APIKEY, --apikey APIKEY IBM Cloud APIKey
Example
export APIKEY=<PLATFORM_API_KEY>
ibm-ai-openscale-cli --apikey $APIKEY
Python version
✅ Tested on Python 3.4, 3.5, and 3.6.
Contributing
See CONTRIBUTING.md.
License
This library is licensed under the Apache 2.0 license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ibm-ai-openscale-cli-0.1.14.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17b976742fb0e7c828931595e5efbe8a89b876aff5ee6c29c2be503151b689a5 |
|
MD5 | f25024ccc97b24ebff1c5d0e3cc2ef82 |
|
BLAKE2b-256 | 337b1079dc01059344eb55617c00e1e799a3c644e9d5715f0cdfdd69b76b2ffc |
Hashes for ibm_ai_openscale_cli-0.1.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e630d23363e9d3bb816bf3bc46f090e727d5d1959426adb182e2a6e9bd326879 |
|
MD5 | 604d85b33937a160cf3359198a016873 |
|
BLAKE2b-256 | f5672aab33d1f923bf2dacc6647b85f8a0a40b91a20e41ade24ab80e4c8f3b77 |