Skip to main content

CLI library to automate the onboarding process to IBM AI OpenScale

Project description

Build Status Latest Stable Version

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

Installation

To install, use pip or easy_install:

pip install -U --process-dependency-links ibm-ai-openscale-cli

or

easy_install -U --process-dependency-links ibm-ai-openscale-cli

Usage:

ibm-ai-openscale-cli --help
usage: ibm-ai-openscale-cli [-h] -a APIKEY [--organization ORGANIZATION]
                            [--space SPACE] [--resource-group RESOURCE_GROUP]
                            [--postgres POSTGRES] [--wml WML]
                            [--datamart-name DATAMART_NAME]
                            [--history HISTORY] [--bx]
                            [--env {ypprod,ypqa,ys1dev,icp}] [--verbose]
                            [--version]

optional arguments:
  -h, --help            show this help message and exit
  --organization ORGANIZATION
                        Cloud Foundry Organization to use
  --space SPACE         Cloud Foundry Space to use
  --resource-group RESOURCE_GROUP
                        Resource Group to use. If not specified, then
                        "default" group is used
  --postgres POSTGRES   Path to postgres credentials file. If not specified,
                        then the internal AIOS database is used
  --wml WML             Path to WML credentials file
  --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
  --env {ypprod,ypqa,ys1dev,icp}
                        Environment. Default "ypprod"
  --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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ibm-ai-openscale-cli-0.1.1.tar.gz (29.9 kB view hashes)

Uploaded Source

Built Distribution

ibm_ai_openscale_cli-0.1.1-py3-none-any.whl (30.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page