deci_lab_client.PlatformApi

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Whether the event was successfully recorded.	-
422	Validation Error	-

add_model

APIResponseAddModelResponse add_model(etag, model_metadata_in)

Add Model

Pushes a model into the model repository.If the model doesn't exist, we will create a new model automatically. If the model already exists, updates the model latest revision to the submitted mode

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    etag = 'etag_example' # str | The unique ETag in S3 for the model being uploaded
model_metadata_in = deci_lab_client.ModelMetadataIn() # ModelMetadataIn | 

    try:
        # Add Model
        api_response = api_instance.add_model(etag, model_metadata_in)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->add_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
etag	str	The unique ETag in S3 for the model being uploaded
model_metadata_in	ModelMetadataIn

Return type

APIResponseAddModelResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

add_model_v2

APIResponseAddModelResponse add_model_v2(etag, body_add_model_v2)

Add Model V2

Pushes a model into the model repository.If the model doesn't exist, we will create a new model automatically. If the model already exists, updates the model latest revision to the submitted mode

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    etag = 'etag_example' # str | The unique ETag in S3 for the model being uploaded
body_add_model_v2 = deci_lab_client.BodyAddModelV2() # BodyAddModelV2 | 

    try:
        # Add Model V2
        api_response = api_instance.add_model_v2(etag, body_add_model_v2)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->add_model_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
etag	str	The unique ETag in S3 for the model being uploaded
body_add_model_v2	BodyAddModelV2

Return type

APIResponseAddModelResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

add_optimized_model

APIResponseUUID add_optimized_model(model_id, etag, optimization_state=optimization_state)

Add Optimized Model

Pushes an optimized model into the model repository.The model should exist in the user's model repository before running this endpoint

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | The id of the model to update its optimized version
etag = 'etag_example' # str | The unique ETag in S3 for the optimized model
optimization_state = deci_lab_client.ModelOptimizationState() # ModelOptimizationState | The updated optimization state to put for the model (optional)

    try:
        # Add Optimized Model
        api_response = api_instance.add_optimized_model(model_id, etag, optimization_state=optimization_state)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->add_optimized_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	The id of the model to update its optimized version
etag	str	The unique ETag in S3 for the optimized model
optimization_state	ModelOptimizationState	The updated optimization state to put for the model	[optional]

Return type

APIResponseUUID

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

assert_model_arguments

APIResponseStr assert_model_arguments(model_metadata)

Assert Model Arguments Before Upload

Verifies the model arguments before upload to the repository.If the model doesn't exist, we will create a new model automatically

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_metadata = deci_lab_client.ModelMetadata() # ModelMetadata | 

    try:
        # Assert Model Arguments Before Upload
        api_response = api_instance.assert_model_arguments(model_metadata)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->assert_model_arguments: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_metadata	ModelMetadata

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

autonac_model

APIResponseOptimizeModelResponse autonac_model(model_id)

Autonac Model

AutoNAC an existing model

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | Base model to create an autoNAC model from

    try:
        # Autonac Model
        api_response = api_instance.autonac_model(model_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->autonac_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	Base model to create an autoNAC model from

Return type

APIResponseOptimizeModelResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

buy_model

APIResponse buy_model(model_purchase_event)

Buy Model

Registers when a user is interested in buying a model

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_purchase_event = deci_lab_client.ModelPurchaseEvent() # ModelPurchaseEvent | 

    try:
        # Buy Model
        api_response = api_instance.buy_model(model_purchase_event)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->buy_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_purchase_event	ModelPurchaseEvent

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

cancel_colleague_invite

APIResponseStr cancel_colleague_invite(invite_colleague_with_workspace)

Cancel Colleague Invite

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    invite_colleague_with_workspace = deci_lab_client.InviteColleagueWithWorkspace() # InviteColleagueWithWorkspace | 

    try:
        # Cancel Colleague Invite
        api_response = api_instance.cancel_colleague_invite(invite_colleague_with_workspace)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->cancel_colleague_invite: %s\n" % e)

Parameters

Name	Type	Description	Notes
invite_colleague_with_workspace	InviteColleagueWithWorkspace

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

compare_models_in_model_zoo

APIResponse compare_models_in_model_zoo(model_name)

Compare Models In Model Zoo

Registers when a user compares models in the Model Zoo page

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_name = ['model_name_example'] # list[str] | 

    try:
        # Compare Models In Model Zoo
        api_response = api_instance.compare_models_in_model_zoo(model_name)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->compare_models_in_model_zoo: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_name	list[str]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

create_workspace

APIResponseWorkspaceBase create_workspace(workspace_form)

Create Workspace

Creates a workspace for the current user

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    workspace_form = deci_lab_client.WorkspaceForm() # WorkspaceForm | 

    try:
        # Create Workspace
        api_response = api_instance.create_workspace(workspace_form)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->create_workspace: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_form	WorkspaceForm

Return type

APIResponseWorkspaceBase

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

delete_conversion_parameters

object delete_conversion_parameters(model_id)

Delete Conversion Parameters

Delete additional conversion parameters for a specified model.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | ID of the model to delete conversion parameters for

    try:
        # Delete Conversion Parameters
        api_response = api_instance.delete_conversion_parameters(model_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->delete_conversion_parameters: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	ID of the model to delete conversion parameters for

Return type

object

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

delete_model

APIResponseDeleteModelResponse delete_model(model_id, force_delete=force_delete)

Delete Model

Deletes a model from the model repository

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | The unique ID of model in the model repository.
force_delete = False # bool |  (optional) (default to False)

    try:
        # Delete Model
        api_response = api_instance.delete_model(model_id, force_delete=force_delete)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->delete_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	The unique ID of model in the model repository.
force_delete	bool		[optional] [default to False]

Return type

APIResponseDeleteModelResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

delete_workspace

APIResponseBool delete_workspace(id)

Delete Workspace

Deletes a workspace

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    id = 'id_example' # str | 

    try:
        # Delete Workspace
        api_response = api_instance.delete_workspace(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->delete_workspace: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

APIResponseBool

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

deploy_model_to_infery

APIResponseListStr deploy_model_to_infery(model_id, hardware=hardware)

Deploy Model To Infery

Generates code snippets to load the model on a local machine, using the Deci's Infery python package.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | The unique ID of model in the model repository.
hardware = deci_lab_client.InferyVersion() # InferyVersion | The infery version that will be used. (optional)

    try:
        # Deploy Model To Infery
        api_response = api_instance.deploy_model_to_infery(model_id, hardware=hardware)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->deploy_model_to_infery: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	The unique ID of model in the model repository.
hardware	InferyVersion	The infery version that will be used.	[optional]

Return type

APIResponseListStr

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

edit_model

APIResponseModelMetadata edit_model(model_id, edit_model_form)

Edit Model

Edit a model of the model repository

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | The unique ID of model in the model repository.
edit_model_form = deci_lab_client.EditModelForm() # EditModelForm | 

    try:
        # Edit Model
        api_response = api_instance.edit_model(model_id, edit_model_form)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->edit_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	The unique ID of model in the model repository.
edit_model_form	EditModelForm

Return type

APIResponseModelMetadata

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

edit_user

APIResponse edit_user(user_id, edit_user_form)

Edit User

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    user_id = 'user_id_example' # str | The unique ID of user.
edit_user_form = deci_lab_client.EditUserForm() # EditUserForm | 

    try:
        # Edit User
        api_response = api_instance.edit_user(user_id, edit_user_form)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->edit_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	The unique ID of user.
edit_user_form	EditUserForm

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

get_all_accuracy_metrics

APIResponseDictDeciCommonDataTypesEnumDeepLearningTaskDeepLearningTaskApiCommonDataTypesGlobalConfigurationDataTypesAccuracyMetricsSchemaResponse get_all_accuracy_metrics()

Get All Accuracy Metrics

Get all the accuracy metrics supported by deci.

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get All Accuracy Metrics
        api_response = api_instance.get_all_accuracy_metrics()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_all_accuracy_metrics: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

APIResponseDictDeciCommonDataTypesEnumDeepLearningTaskDeepLearningTaskApiCommonDataTypesGlobalConfigurationDataTypesAccuracyMetricsSchemaResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_architectures

APIResponseList get_all_architectures()

Get All Architecture

Get all the deep learning architectures supported by deci.

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get All Architecture
        api_response = api_instance.get_all_architectures()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_all_architectures: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

APIResponseList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_batch_sizes

APIResponseUnionListDeciCommonDataTypesEnumModelsEnumsBatchSizeDictStrListPydanticTypesPositiveInt get_all_batch_sizes(detailed=detailed)

Get All Batch Sizes

Get all the batch sizes supported by deci.

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    detailed = False # bool | Whether we should return a dictionary of hardware environment to batch sizes or a list of batch sizes (optional) (default to False)

    try:
        # Get All Batch Sizes
        api_response = api_instance.get_all_batch_sizes(detailed=detailed)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_all_batch_sizes: %s\n" % e)

Parameters

Name	Type	Description	Notes
detailed	bool	Whether we should return a dictionary of hardware environment to batch sizes or a list of batch sizes	[optional] [default to False]

Return type

APIResponseUnionListDeciCommonDataTypesEnumModelsEnumsBatchSizeDictStrListPydanticTypesPositiveInt

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_dp_tasks

APIResponseList get_all_dp_tasks()

Get All Dp Tasks

Get all the deep learning tasks supported by deci.

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get All Dp Tasks
        api_response = api_instance.get_all_dp_tasks()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_all_dp_tasks: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

APIResponseList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_feature_flags

APIResponseListDeciInfraDataTypesFeatureFlagFeatureFlag get_all_feature_flags()

Get All Feature Flags

Get all the deci`s feature flags.

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get All Feature Flags
        api_response = api_instance.get_all_feature_flags()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_all_feature_flags: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

APIResponseListDeciInfraDataTypesFeatureFlagFeatureFlag

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_frameworks

APIResponseListDeciCommonDataTypesEnumModelFrameworksFrameworkType get_all_frameworks()

Get All Frameworks

Get all the deep learning frameworks supported by deci.

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get All Frameworks
        api_response = api_instance.get_all_frameworks()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_all_frameworks: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

APIResponseListDeciCommonDataTypesEnumModelFrameworksFrameworkType

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_hardware_types

APIResponseListDeciCommonDataTypesHardwareHardwareReturnSchema get_all_hardware_types()

Get All Hardware Types

Get all the hardware-types supported by deci.

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get All Hardware Types
        api_response = api_instance.get_all_hardware_types()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_all_hardware_types: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

APIResponseListDeciCommonDataTypesHardwareHardwareReturnSchema

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_hardwares

list[Hardware] get_all_hardwares()

Get All Hardwares

Get all hardwares supported by Deci

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get All Hardwares
        api_response = api_instance.get_all_hardwares()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_all_hardwares: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[Hardware]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_models

APIResponseListDeciInfraDataTypesDeepLearningModelBaselineModelResponseMetadata get_all_models(reorder=reorder, with_autonacs=with_autonacs, with_deleted=with_deleted, ids=ids)

Get Models

Get all the models of the logged in user/organization.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    reorder = False # bool |  (optional) (default to False)
with_autonacs = True # bool |  (optional) (default to True)
with_deleted = False # bool |  (optional) (default to False)
ids = ['ids_example'] # list[str] | List of model ids to query the models metadata from, if not given all will be fetched. (optional)

    try:
        # Get Models
        api_response = api_instance.get_all_models(reorder=reorder, with_autonacs=with_autonacs, with_deleted=with_deleted, ids=ids)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_all_models: %s\n" % e)

Parameters

Name	Type	Description	Notes
reorder	bool		[optional] [default to False]
with_autonacs	bool		[optional] [default to True]
with_deleted	bool		[optional] [default to False]
ids	list[str]	List of model ids to query the models metadata from, if not given all will be fetched.	[optional]

Return type

APIResponseListDeciInfraDataTypesDeepLearningModelBaselineModelResponseMetadata

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

get_all_performance_metrics

APIResponseListDeciCommonDataTypesEnumModelsEnumsMetric get_all_performance_metrics()

Get All Performance Metrics

Get all the performance metrics supported by deci.

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get All Performance Metrics
        api_response = api_instance.get_all_performance_metrics()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_all_performance_metrics: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

APIResponseListDeciCommonDataTypesEnumModelsEnumsMetric

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_quantization_levels

APIResponseListDeciCommonDataTypesEnumModelsEnumsQuantizationLevel get_all_quantization_levels()

Get All Quantization Levels

Get all the quantization levels supported by deci.

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get All Quantization Levels
        api_response = api_instance.get_all_quantization_levels()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_all_quantization_levels: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

APIResponseListDeciCommonDataTypesEnumModelsEnumsQuantizationLevel

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_users

APIResponseListDeciInfraDataTypesUserUser get_all_users(first_name=first_name, last_name=last_name, email=email, _self=_self)

Get All Users

Gets all the workspace users

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    first_name = 'first_name_example' # str | The name of the user to filter by.  (optional)
last_name = 'last_name_example' # str | The name of the user to filter by.  (optional)
email = 'email_example' # str | The email of the user to filter by.  (optional)
_self = False # bool | Do you want to return only your own user metadata?  (optional) (default to False)

    try:
        # Get All Users
        api_response = api_instance.get_all_users(first_name=first_name, last_name=last_name, email=email, _self=_self)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_all_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
first_name	str	The name of the user to filter by.	[optional]
last_name	str	The name of the user to filter by.	[optional]
email	str	The email of the user to filter by.	[optional]
_self	bool	Do you want to return only your own user metadata?	[optional] [default to False]

Return type

APIResponseListDeciInfraDataTypesUserUser

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the users metadata.	-
422	Validation Error	-

get_all_workspaces

APIResponseListDeciInfraDataTypesWorkspaceWorkspaceBase get_all_workspaces()

Get Workspaces

Fetches all user workspaces

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get Workspaces
        api_response = api_instance.get_all_workspaces()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_all_workspaces: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

APIResponseListDeciInfraDataTypesWorkspaceWorkspaceBase

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

get_api_version

APIResponseStr get_api_version()

Request Version

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Request Version
        api_response = api_instance.get_api_version()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_api_version: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

get_architectures

Architectures get_architectures()

Get Architectures

Get All Architectures

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get Architectures
        api_response = api_instance.get_architectures()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_architectures: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Architectures

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

get_autonac_model_file_link

APIResponseStr get_autonac_model_file_link(model_name, file_name, super_gradients_version=super_gradients_version)

Get Model File Download Link

Get a pre-signed URL to download one of an AutoNAC model's files

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_name = 'model_name_example' # str | 
file_name = deci_lab_client.AutoNACFileName() # AutoNACFileName | 
super_gradients_version = 'super_gradients_version_example' # str |  (optional)

    try:
        # Get Model File Download Link
        api_response = api_instance.get_autonac_model_file_link(model_name, file_name, super_gradients_version=super_gradients_version)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_autonac_model_file_link: %s\n" % e)

Parameters

Name	Type	Notes
model_name	str
file_name	AutoNACFileName
super_gradients_version	str	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

get_benchmark_request

APIResponseBenchmarkRequestMetadata get_benchmark_request(benchmark_request_id)

Get Benchmark Request

Run benchmark cycle on an existing model.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    benchmark_request_id = 'benchmark_request_id_example' # str | The unique id of benchmark request.

    try:
        # Get Benchmark Request
        api_response = api_instance.get_benchmark_request(benchmark_request_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_benchmark_request: %s\n" % e)

Parameters

Name	Type	Description	Notes
benchmark_request_id	str	The unique id of benchmark request.

Return type

APIResponseBenchmarkRequestMetadata

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

get_company

APIResponseCompanyResponseMetadata get_company()

Get Company

Gets the information about your company

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get Company
        api_response = api_instance.get_company()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_company: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

APIResponseCompanyResponseMetadata

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the company metadata.	-

get_company_stats

APIResponseWorkspaceStatsData get_company_stats()

Get Company Stats

Gets the stats about your company

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get Company Stats
        api_response = api_instance.get_company_stats()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_company_stats: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

APIResponseWorkspaceStatsData

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the company stats.	-

get_conversion_parameters

ConversionParametersResponse get_conversion_parameters(model_id)

Get Conversion Parameters

Get additional conversion parameters for a specified model.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | ID of the model to get conversion parameters for

    try:
        # Get Conversion Parameters
        api_response = api_instance.get_conversion_parameters(model_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_conversion_parameters: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	ID of the model to get conversion parameters for

Return type

ConversionParametersResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

get_events

APIResponseListDeciInfraDataTypesUserUserEvent get_events(type=type, include_completed=include_completed)

Get Events

Get current user events.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    type = [deci_lab_client.UserEventType()] # list[UserEventType] | Get only specific types of events (optional)
include_completed = False # bool | Whether to include already completed events of the current user (optional) (default to False)

    try:
        # Get Events
        api_response = api_instance.get_events(type=type, include_completed=include_completed)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_events: %s\n" % e)

Parameters

Name	Type	Description	Notes
type	list[UserEventType]	Get only specific types of events	[optional]
include_completed	bool	Whether to include already completed events of the current user	[optional] [default to False]

Return type

APIResponseListDeciInfraDataTypesUserUserEvent

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of all user recorded events.	-
422	Validation Error	-

get_experiment_upload_url

APIResponseDictStrAny get_experiment_upload_url(experiment_id, filename, model_id=model_id)

Get Experiment Upload Url

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    experiment_id = 'experiment_id_example' # str | 
filename = 'filename_example' # str | 
model_id = 'model_id_example' # str | The ID of the model the experiment is running with. (optional)

    try:
        # Get Experiment Upload Url
        api_response = api_instance.get_experiment_upload_url(experiment_id, filename, model_id=model_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_experiment_upload_url: %s\n" % e)

Parameters

Name	Type	Description	Notes
experiment_id	str
filename	str
model_id	str	The ID of the model the experiment is running with.	[optional]

Return type

APIResponseDictStrAny

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns a signed url for cloud upload	-
422	Validation Error	-

get_experiments_counter

dict(str, int) get_experiments_counter()

Get Experiments Counter

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get Experiments Counter
        api_response = api_instance.get_experiments_counter()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_experiments_counter: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

dict(str, int)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns a dictionary mapping all autonac ids of a given workspace to the number of active experiments	-

get_invite_by_token

APIResponseInviteInDB get_invite_by_token(token)

Get Invite By Token

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    token = 'token_example' # str | 

    try:
        # Get Invite By Token
        api_response = api_instance.get_invite_by_token(token)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_invite_by_token: %s\n" % e)

Parameters

Name	Type	Description	Notes
token	str

Return type

APIResponseInviteInDB

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_invites

APIResponseListDeciInfraDataTypesInvitationsDataTypesInviteInDB get_invites(public=public, workspace_id=workspace_id)

Get Invites

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    public = False # bool |  (optional) (default to False)
workspace_id = 'workspace_id_example' # str |  (optional)

    try:
        # Get Invites
        api_response = api_instance.get_invites(public=public, workspace_id=workspace_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_invites: %s\n" % e)

Parameters

Name	Type	Description	Notes
public	bool		[optional] [default to False]
workspace_id	str		[optional]

Return type

APIResponseListDeciInfraDataTypesInvitationsDataTypesInviteInDB

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

get_model_by_id

APIResponseBaselineModelResponseMetadata get_model_by_id(model_id, reorder=reorder)

Get Model By Id

Gets a model by it's unique ID

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | The unique ID of model in the model repository.
reorder = False # bool |  (optional) (default to False)

    try:
        # Get Model By Id
        api_response = api_instance.get_model_by_id(model_id, reorder=reorder)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_model_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	The unique ID of model in the model repository.
reorder	bool		[optional] [default to False]

Return type

APIResponseBaselineModelResponseMetadata

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the model metadata	-
422	Validation Error	-

get_model_by_name

APIResponseBaselineModelResponseMetadata get_model_by_name(name, reorder=reorder, version=version)

Get Model By Name

Get a model with specific name

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    name = 'name_example' # str | The model name
reorder = False # bool |  (optional) (default to False)
version = 'version_example' # str | Version of the model to retrieve (for example: 1.2) (optional)

    try:
        # Get Model By Name
        api_response = api_instance.get_model_by_name(name, reorder=reorder, version=version)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_model_by_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	The model name
reorder	bool		[optional] [default to False]
version	str	Version of the model to retrieve (for example: 1.2)	[optional]

Return type

APIResponseBaselineModelResponseMetadata

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

get_model_signed_url_for_download

APIResponseStr get_model_signed_url_for_download(model_id)

Get Model Signed Url For Download

Generates a temporary url, valid for 1 hour. The returned URL should be used with HTTP GET method to download the model file.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | The unique ID of model in the model repository.

    try:
        # Get Model Signed Url For Download
        api_response = api_instance.get_model_signed_url_for_download(model_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_model_signed_url_for_download: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	The unique ID of model in the model repository.

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

get_model_signed_url_for_upload

APIResponse get_model_signed_url_for_upload(model_name, model_version=model_version)

Get Model Signed Url For Upload

Generates a temporary url that includes an access verification_token for a HTTP PUT method, So clients can upload a non-optimized version (1.0) of their model binary file. The returned URL should be used via a PUT method with the model file.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_name = 'model_name_example' # str | The name of the model
model_version = '1.0' # str | The version of the model (optional) (default to '1.0')

    try:
        # Get Model Signed Url For Upload
        api_response = api_instance.get_model_signed_url_for_upload(model_name, model_version=model_version)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_model_signed_url_for_upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_name	str	The name of the model
model_version	str	The version of the model	[optional] [default to '1.0']

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

get_model_zoo

APIResponseListDeciInfraDataTypesDeepLearningModelModelZooResponseMetadata get_model_zoo(task=task)

Get Model Zoo

Fetches the public models for the model zoo representation

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    task = deci_lab_client.DeepLearningTask() # DeepLearningTask |  (optional)

    try:
        # Get Model Zoo
        api_response = api_instance.get_model_zoo(task=task)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_model_zoo: %s\n" % e)

Parameters

Name	Type	Description	Notes
task	DeepLearningTask		[optional]

Return type

APIResponseListDeciInfraDataTypesDeepLearningModelModelZooResponseMetadata

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

get_optimized_models

APIResponseListDeciInfraDataTypesDeepLearningModelModelMetadata get_optimized_models(model_id, autonac_only=autonac_only)

Get Optimized Models

Gets all optimized models of baseline model

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | The unique id of baseline model in the model repository.
autonac_only = False # bool | A predicate whether to fetch only AutoNAC optimized models. (optional) (default to False)

    try:
        # Get Optimized Models
        api_response = api_instance.get_optimized_models(model_id, autonac_only=autonac_only)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_optimized_models: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	The unique id of baseline model in the model repository.
autonac_only	bool	A predicate whether to fetch only AutoNAC optimized models.	[optional] [default to False]

Return type

APIResponseListDeciInfraDataTypesDeepLearningModelModelMetadata

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns a list of optimized models metadata.	-
422	Validation Error	-

get_snippets_from_template

APIResponseTemplateResponse get_snippets_from_template(name)

Get Snippets From Template

Get snippets from a template

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    name = 'name_example' # str | 

    try:
        # Get Snippets From Template
        api_response = api_instance.get_snippets_from_template(name)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_snippets_from_template: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str

Return type

APIResponseTemplateResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	add_and_optimize_pytorch_model: Required placeholders - ['authToken', 'name', 'dlTask', 'hardwareTypes', 'inputDimensions', 'channelFirst', 'primaryBatchSize', 'quantizationLevel', 'rawFormat'], Optional placeholders: ['description', 'accuracy'], User input placeholders: ['model'] * add_pytorch_architecture: Required placeholders - ['authToken', 'name', 'dlTask', 'primaryHardwareType', 'inputDimensions', 'channelFirst', 'primaryBatchSize', 'quantizationLevel'], Optional placeholders: ['description', 'accuracy', 'datasetName', 'targetMetric', 'targetMetricValue', 'modelSize', 'memoryFootprint'], User input placeholders: ['model'] * add_pytorch_model: Required placeholders - ['authToken', 'name', 'dlTask', 'hardwareTypes', 'inputDimensions', 'channelFirst'], Optional placeholders: ['description', 'accuracy'], User input placeholders: ['model']	-
422	Validation Error	-

get_user_activity_by_user_id

APIResponseDictDeciInfraDataTypesEnumUsersEnumsActivityEventNameInt get_user_activity_by_user_id(user_id)

Get User Activity By User Id

Gets a activity of a user by it's unique ID

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    user_id = 'user_id_example' # str | The unique ID of user.

    try:
        # Get User Activity By User Id
        api_response = api_instance.get_user_activity_by_user_id(user_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_user_activity_by_user_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	The unique ID of user.

Return type

APIResponseDictDeciInfraDataTypesEnumUsersEnumsActivityEventNameInt

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the user activity.	-
422	Validation Error	-

get_user_by_id

APIResponseUser get_user_by_id(user_id)

Get User By Id

Gets a user by it's unique ID

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    user_id = 'user_id_example' # str | The unique ID of user.

    try:
        # Get User By Id
        api_response = api_instance.get_user_by_id(user_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_user_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	The unique ID of user.

Return type

APIResponseUser

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the user metadata.	-
422	Validation Error	-

get_workspace_by_id

APIResponseWorkspaceBase get_workspace_by_id(id)

Get Workspace

Fetches single workspace by its ID

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    id = 'id_example' # str | 

    try:
        # Get Workspace
        api_response = api_instance.get_workspace_by_id(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_workspace_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

APIResponseWorkspaceBase

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

get_workspace_experiments

list[TrainingExperiment] get_workspace_experiments(architecture_ids=architecture_ids)

Get Workspace Experiments

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    architecture_ids = ['architecture_ids_example'] # list[str] | Limit experiments to a subset of model ids (optional)

    try:
        # Get Workspace Experiments
        api_response = api_instance.get_workspace_experiments(architecture_ids=architecture_ids)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_workspace_experiments: %s\n" % e)

Parameters

Name	Type	Description	Notes
architecture_ids	list[str]	Limit experiments to a subset of model ids	[optional]

Return type

list[TrainingExperiment]

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns all of the active, non-deleted experiments in the workspace	-
422	Validation Error	-

get_workspace_members

APIResponseListDeciInfraDataTypesUserUser get_workspace_members(workspace_id)

Get Workspace Members

Returns all members of a given workspace

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    workspace_id = 'workspace_id_example' # str | 

    try:
        # Get Workspace Members
        api_response = api_instance.get_workspace_members(workspace_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_workspace_members: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_id	str

Return type

APIResponseListDeciInfraDataTypesUserUser

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

get_workspace_stats

WorkspaceStatsData get_workspace_stats()

Get Workspace Stats

Gets the stats about your workspace

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Get Workspace Stats
        api_response = api_instance.get_workspace_stats()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->get_workspace_stats: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

WorkspaceStatsData

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the workspace stats.	-

gru_model

APIResponseGruModelResponse gru_model(model_id, gru_request_form)

Gru Model

Run Gru on an existing model. Gru operation runs optimization on all hardwares for batch size 1 and quantization level FP16

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | The unique id of model in the model repository.
gru_request_form = deci_lab_client.GruRequestForm() # GruRequestForm | 

    try:
        # Gru Model
        api_response = api_instance.gru_model(model_id, gru_request_form)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->gru_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	The unique id of model in the model repository.
gru_request_form	GruRequestForm

Return type

APIResponseGruModelResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

health_check

APIResponse health_check()

Health

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Health
        api_response = api_instance.health_check()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->health_check: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

import_public_model

APIResponseStr import_public_model(public_model_id, model_name=model_name)

Import Public Model

Clone a public model into client private model repository

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    public_model_id = 'public_model_id_example' # str | 
model_name = 'model_name_example' # str | Name of the requested model for get architecture recording (optional)

    try:
        # Import Public Model
        api_response = api_instance.import_public_model(public_model_id, model_name=model_name)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->import_public_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
public_model_id	str
model_name	str	Name of the requested model for get architecture recording	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

invite_colleague_to_join_workspace

APIResponse invite_colleague_to_join_workspace(invite_colleague_with_workspace)

Invite Colleague

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    invite_colleague_with_workspace = deci_lab_client.InviteColleagueWithWorkspace() # InviteColleagueWithWorkspace | 

    try:
        # Invite Colleague
        api_response = api_instance.invite_colleague_to_join_workspace(invite_colleague_with_workspace)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->invite_colleague_to_join_workspace: %s\n" % e)

Parameters

Name	Type	Description	Notes
invite_colleague_with_workspace	InviteColleagueWithWorkspace

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

log

APIResponse log(log_request_body)

Upload Log

Register logs for Deci support.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    log_request_body = deci_lab_client.LogRequestBody() # LogRequestBody | 

    try:
        # Upload Log
        api_response = api_instance.log(log_request_body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->log: %s\n" % e)

Parameters

Name	Type	Description	Notes
log_request_body	LogRequestBody

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

Token login(username, password, grant_type=grant_type, scope=scope, client_id=client_id, client_secret=client_secret)

Get Access Token

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    username = 'username_example' # str | 
password = 'password_example' # str | 
grant_type = 'grant_type_example' # str |  (optional)
scope = '' # str |  (optional) (default to '')
client_id = 'client_id_example' # str |  (optional)
client_secret = 'client_secret_example' # str |  (optional)

    try:
        # Get Access Token
        api_response = api_instance.login(username, password, grant_type=grant_type, scope=scope, client_id=client_id, client_secret=client_secret)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->login: %s\n" % e)

Parameters

Name	Type	Notes
username	str
password	str
grant_type	str	[optional]
scope	str	[optional] [default to '']
client_id	str	[optional]
client_secret	str	[optional]

Return type

Token

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

optimize_model

APIResponseOptimizeModelResponse optimize_model(model_id, optimization_request_form)

Optimize Model

Optimize an existing model for specific hardware.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | The unique id of model in the model repository.
optimization_request_form = deci_lab_client.OptimizationRequestForm() # OptimizationRequestForm | 

    try:
        # Optimize Model
        api_response = api_instance.optimize_model(model_id, optimization_request_form)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->optimize_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	The unique id of model in the model repository.
optimization_request_form	OptimizationRequestForm

Return type

APIResponseOptimizeModelResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

quota_increase

APIResponse quota_increase(quota_increase_request_event)

Request Quota Increase

Registers when a user requests a quota increase

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    quota_increase_request_event = deci_lab_client.QuotaIncreaseRequestEvent() # QuotaIncreaseRequestEvent | 

    try:
        # Request Quota Increase
        api_response = api_instance.quota_increase(quota_increase_request_event)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->quota_increase: %s\n" % e)

Parameters

Name	Type	Description	Notes
quota_increase_request_event	QuotaIncreaseRequestEvent

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

register_user_architecture

UserArchitecture register_user_architecture(body_register_user_architecture)

Register User Architecture

Register a non-AutoNAC architecture

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    body_register_user_architecture = deci_lab_client.BodyRegisterUserArchitecture() # BodyRegisterUserArchitecture | 

    try:
        # Register User Architecture
        api_response = api_instance.register_user_architecture(body_register_user_architecture)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->register_user_architecture: %s\n" % e)

Parameters

Name	Type	Description	Notes
body_register_user_architecture	BodyRegisterUserArchitecture

Return type

UserArchitecture

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

request_model

APIResponse request_model(model_request_event)

Request Model

Registers when a user requests a missing model in the system

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_request_event = deci_lab_client.ModelRequestEvent() # ModelRequestEvent | 

    try:
        # Request Model
        api_response = api_instance.request_model(model_request_event)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->request_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_request_event	ModelRequestEvent

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

request_public_architecture

APIResponse request_public_architecture(model_name)

Request Public Architecture

Registers when a user request architecture in the Model Zoo page

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_name = 'model_name_example' # str | 

    try:
        # Request Public Architecture
        api_response = api_instance.request_public_architecture(model_name)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->request_public_architecture: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_name	str

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

request_support

APIResponseStr request_support(support_request_form)

Request Support

Requests Deci support to contact you.

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    support_request_form = deci_lab_client.SupportRequestForm() # SupportRequestForm | 

    try:
        # Request Support
        api_response = api_instance.request_support(support_request_form)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->request_support: %s\n" % e)

Parameters

Name	Type	Description	Notes
support_request_form	SupportRequestForm

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

reset_password

APIResponseStr reset_password(email)

Reset Password

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    email = 'email_example' # str | 

    try:
        # Reset Password
        api_response = api_instance.reset_password(email)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->reset_password: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

send_model_benchmark_request

str send_model_benchmark_request(model_id, body_send_model_benchmark_request=body_send_model_benchmark_request)

Benchmark Model

Run benchmark cycle on an existing model.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | The unique id of model in the model repository.
body_send_model_benchmark_request = deci_lab_client.BodySendModelBenchmarkRequest() # BodySendModelBenchmarkRequest |  (optional)

    try:
        # Benchmark Model
        api_response = api_instance.send_model_benchmark_request(model_id, body_send_model_benchmark_request=body_send_model_benchmark_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->send_model_benchmark_request: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	The unique id of model in the model repository.
body_send_model_benchmark_request	BodySendModelBenchmarkRequest		[optional]

Return type

str

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

set_conversion_parameters

ConversionParametersResponse set_conversion_parameters(model_id, body)

Set Conversion Parameters

Set additional conversion parameters for a specified model.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    model_id = 'model_id_example' # str | ID of the model to set conversion parameters for
body = None # object | 

    try:
        # Set Conversion Parameters
        api_response = api_instance.set_conversion_parameters(model_id, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->set_conversion_parameters: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_id	str	ID of the model to set conversion parameters for
body	object

Return type

ConversionParametersResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

set_password

APIResponseStr set_password(password, auth_token)

Set Password

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    password = 'password_example' # str | 
auth_token = 'auth_token_example' # str | 

    try:
        # Set Password
        api_response = api_instance.set_password(password, auth_token)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->set_password: %s\n" % e)

Parameters

Name	Type	Description	Notes
password	str
auth_token	str

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

sign_in_with_provider

APIResponseProviderAuthenticationResponse sign_in_with_provider(provider, body_sign_in_with_provider)

Auth With Provider

Server to server verification against the provider that the token is valid

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    provider = deci_lab_client.AuthProvider() # AuthProvider | 
body_sign_in_with_provider = deci_lab_client.BodySignInWithProvider() # BodySignInWithProvider | 

    try:
        # Auth With Provider
        api_response = api_instance.sign_in_with_provider(provider, body_sign_in_with_provider)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->sign_in_with_provider: %s\n" % e)

Parameters

Name	Type	Description	Notes
provider	AuthProvider
body_sign_in_with_provider	BodySignInWithProvider

Return type

APIResponseProviderAuthenticationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sign_up_user

APIResponseUUID sign_up_user(invited_signup)

Sign Up User

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    invited_signup = deci_lab_client.InvitedSignup() # InvitedSignup | 

    try:
        # Sign Up User
        api_response = api_instance.sign_up_user(invited_signup)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->sign_up_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
invited_signup	InvitedSignup

Return type

APIResponseUUID

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

start_experiment

APIResponseTrainingExperiment start_experiment(experiment_form)

Register Experiment

Register/resume a training experiment

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    experiment_form = deci_lab_client.ExperimentForm() # ExperimentForm | 

    try:
        # Register Experiment
        api_response = api_instance.start_experiment(experiment_form)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->start_experiment: %s\n" % e)

Parameters

Name	Type	Description	Notes
experiment_form	ExperimentForm

Return type

APIResponseTrainingExperiment

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A TrainingExperiment	-
422	Validation Error	-

switch_to_workspace

APIResponseToken switch_to_workspace(workspace_id)

Switch Workspace

Changes workspace context

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    workspace_id = 'workspace_id_example' # str | 

    try:
        # Switch Workspace
        api_response = api_instance.switch_to_workspace(workspace_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->switch_to_workspace: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_id	str

Return type

APIResponseToken

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

update_user_activity

APIResponse update_user_activity(user_id, user_activity)

Update User Activity

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    user_id = 'user_id_example' # str | The unique ID of user.
user_activity = deci_lab_client.ActivityEventName() # ActivityEventName | 

    try:
        # Update User Activity
        api_response = api_instance.update_user_activity(user_id, user_activity)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->update_user_activity: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	The unique ID of user.
user_activity	ActivityEventName

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

update_workspace

APIResponseWorkspaceBase update_workspace(id, workspace_form)

Update Workspace

Updates a workspace

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    id = 'id_example' # str | 
workspace_form = deci_lab_client.WorkspaceForm() # WorkspaceForm | 

    try:
        # Update Workspace
        api_response = api_instance.update_workspace(id, workspace_form)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->update_workspace: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
workspace_form	WorkspaceForm

Return type

APIResponseWorkspaceBase

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

upgrade_plan

APIResponseStr upgrade_plan()

Request Platform Upgrade

Requests an upgrade for the platform product.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)

    try:
        # Request Platform Upgrade
        api_response = api_instance.upgrade_plan()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->upgrade_plan: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Whether the upgrade request was successfully recorded.	-

upload_log_url

APIResponseDictStrAny upload_log_url(tag=tag, level=level)

Get Upload Support Log Url

Get URL to upload logs for Deci support.

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    tag = 'general' # str | Support tag to add to logs (optional) (default to 'general')
level = deci_lab_client.SentryLevel() # SentryLevel | Sentry log level (optional)

    try:
        # Get Upload Support Log Url
        api_response = api_instance.upload_log_url(tag=tag, level=level)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->upload_log_url: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag	str	Support tag to add to logs	[optional] [default to 'general']
level	SentryLevel	Sentry log level	[optional]

Return type

APIResponseDictStrAny

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

validate_model_name

ModelNameValidationResult validate_model_name(body_validate_model_name)

Validate Model Name

Validate a model's name meets requirements: uniqueness to workspace, and format

Example

OAuth Authentication (OAuth2PasswordBearer):

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint
configuration = deci_lab_client.Configuration()
# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    body_validate_model_name = deci_lab_client.BodyValidateModelName() # BodyValidateModelName | 

    try:
        # Validate Model Name
        api_response = api_instance.validate_model_name(body_validate_model_name)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->validate_model_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
body_validate_model_name	BodyValidateModelName

Return type

ModelNameValidationResult

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

verify_email

APIResponse verify_email(token_key)

Verify Email Token

Verifies an email after sign up, using a custom link the includes the email and the token.

Example

from __future__ import print_function
import time
import deci_lab_client
from deci_lab_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with deci_lab_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = deci_lab_client.PlatformApi(api_client)
    token_key = 'token_key_example' # str | 

    try:
        # Verify Email Token
        api_response = api_instance.verify_email(token_key)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PlatformApi->verify_email: %s\n" % e)

Parameters

Name	Type	Description	Notes
token_key	str

Return type