Getting Started with the SDK

anatools is Rendered.ai’s SDK for connecting to the Rendered.ai Platform.

Follow the steps on PyPI to get the SDK installed on your machine using pip. You must have an active Rendered.ai account to use the SDK. Your Rendered.ai account credentials can be used both for the SDK and the Rendered.ai web interface.

Multiple ways to login

Login with Email

Execute the python command line, create a client, and login to Rendered.ai. In this example we are instantiating a client with no workspace or environment variables, so it is setting our default workspace. To access the tool, you will need to use your email and password for https://deckard.rendered.ai.

>>> import anatools
>>> ana = anatools.client()
'Enter your credentials for the Rendered.ai Platform.'
'email:' [e-mail]
'password:' ***************

Login with API Keys

You must first generate an API Key in order to log in with it. You can generate as many API keys as you desire with custom expiration dates in order to bypass the email login. The context for the login session via an API Key is pre-set to the Organization the key was created for.

Create keys via your email login

Run create_api_key with name, optional expiration date, and the Organization ID for the context. Make sure to save the resulting output that is your new API Key. This will only be shown once.

>>> ana.create_api_key(name='name', expires='mm-dd-yyyy', organizationId='OrgId')
'apikey-12345...'

Now you can log in with the API key in one of two ways:

1. API Key Param

Set APIKey to your API Key on client instantiation:

>>> import anatools
>>> ana = anatools.client(APIKey='API KEY')
Using provided APIKey to login ....

2. Environment Variable: RENDEREDAI_API_KEY

Export the key string to the RENDEREDAI_API_KEY environment variable in your active command line or save it in your OS path variables. If no key is detected, then you will get the prompt to enter your email/password.

export RENDEREDAI_API_KEY=API_KEY
python
>>> import anatools
>>> ana = anatools.client()
Using environment RENDEREDAI_API_KEY key to login ....

How to use the anatools SDK

After logging into Rendered.ai with the SDK, you can

• Browse and Manage your Organizations and Workspaces

• Deploy and Manage your Organization Channel(s)

  • Upload and Manage Volume Data required for your Channels

  • Set Default Graph for a Managed Channel

• Get information about the Channels that are available to you

• Create, Manage, and Download Staged Graph

• Generate, Manage, and Download Synthetic Datasets

• Generate, Manage, and Download Annotations locally or in the Platform Cloud

• Generate and View Analytics

• Generate GAN-based datasets

• Generate UMAP comparison between datasets

Detailed documentation can be found in the SDK Developer Guide.