Skip to content

Latest commit

 

History

History
586 lines (412 loc) · 19.4 KB

ExperimentsApi.md

File metadata and controls

586 lines (412 loc) · 19.4 KB

seldon_deploy_sdk.ExperimentsApi

All URIs are relative to http://X.X.X.X/seldon-deploy/api/v1alpha1

Method HTTP request Description
create_canary_experiment POST /namespaces/{namespace}/pipelines/{name}/experiment/canary
create_pipeline_experiment POST /namespaces/{namespace}/pipelines/{name}/experiment
create_shadow_experiment POST /namespaces/{namespace}/pipelines/{name}/experiment/shadow
delete_pipeline_experiment DELETE /namespaces/{namespace}/pipelines/{name}/experiment
get_pipeline_experiment GET /namespaces/{namespace}/pipelines/{name}/experiment
promote_canary PUT /namespaces/{namespace}/pipelines/{name}/experiment/canary
promote_shadow PUT /namespaces/{namespace}/pipelines/{name}/experiment/shadow
remove_canary DELETE /namespaces/{namespace}/pipelines/{name}/experiment/canary
remove_shadow DELETE /namespaces/{namespace}/pipelines/{name}/experiment/shadow
update_pipeline_experiment PUT /namespaces/{namespace}/pipelines/{name}/experiment

create_canary_experiment

object create_canary_experiment(name, namespace, weight, action=action, message=message)

Create the specified Seldon Pipeline Canary experiment

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
weight = 789 # int | Weight of the traffic directed to the canary pipeline, between 0 and 100
action = 'action_example' # str | Action (optional)
message = 'message_example' # str | Message (optional)

try:
    api_response = api_instance.create_canary_experiment(name, namespace, weight, action=action, message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsApi->create_canary_experiment: %s\n" % e)

Parameters

Name Type Description Notes
name str Name identifies a resource
namespace str Namespace provides a logical grouping of resources
weight int Weight of the traffic directed to the canary pipeline, between 0 and 100
action str Action [optional]
message str Message [optional]

Return type

object

Authorization

OAuth2

HTTP request headers

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

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

create_pipeline_experiment

SeldonExperiment create_pipeline_experiment(name, namespace, experiment, action=action, message=message)

Create a Seldon Pipeline Experiment

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
experiment = seldon_deploy_sdk.Experiment() # Experiment | Seldon Experiment
action = 'action_example' # str | Action (optional)
message = 'message_example' # str | Message (optional)

try:
    api_response = api_instance.create_pipeline_experiment(name, namespace, experiment, action=action, message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsApi->create_pipeline_experiment: %s\n" % e)

Parameters

Name Type Description Notes
name str Name identifies a resource
namespace str Namespace provides a logical grouping of resources
experiment Experiment Seldon Experiment
action str Action [optional]
message str Message [optional]

Return type

SeldonExperiment

Authorization

OAuth2

HTTP request headers

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

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

create_shadow_experiment

object create_shadow_experiment(name, namespace, action=action, message=message)

Create the specified Seldon Pipeline Shadow experiment

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
action = 'action_example' # str | Action (optional)
message = 'message_example' # str | Message (optional)

try:
    api_response = api_instance.create_shadow_experiment(name, namespace, action=action, message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsApi->create_shadow_experiment: %s\n" % e)

Parameters

Name Type Description Notes
name str Name identifies a resource
namespace str Namespace provides a logical grouping of resources
action str Action [optional]
message str Message [optional]

Return type

object

Authorization

OAuth2

HTTP request headers

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

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

delete_pipeline_experiment

object delete_pipeline_experiment(name, namespace)

Delete Seldon Pipeline Experiment Pipelines

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources

try:
    api_response = api_instance.delete_pipeline_experiment(name, namespace)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsApi->delete_pipeline_experiment: %s\n" % e)

Parameters

Name Type Description Notes
name str Name identifies a resource
namespace str Namespace provides a logical grouping of resources

Return type

object

Authorization

OAuth2

HTTP request headers

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

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

get_pipeline_experiment

SeldonExperiment get_pipeline_experiment(name, namespace)

Read Seldon Pipeline Experiment

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources

try:
    api_response = api_instance.get_pipeline_experiment(name, namespace)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsApi->get_pipeline_experiment: %s\n" % e)

Parameters

Name Type Description Notes
name str Name identifies a resource
namespace str Namespace provides a logical grouping of resources

Return type

SeldonExperiment

Authorization

OAuth2

HTTP request headers

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

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

promote_canary

object promote_canary(name, namespace, action=action, message=message)

Promote the specified Seldon Pipeline Canary

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
action = 'action_example' # str | Action (optional)
message = 'message_example' # str | Message (optional)

try:
    api_response = api_instance.promote_canary(name, namespace, action=action, message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsApi->promote_canary: %s\n" % e)

Parameters

Name Type Description Notes
name str Name identifies a resource
namespace str Namespace provides a logical grouping of resources
action str Action [optional]
message str Message [optional]

Return type

object

Authorization

OAuth2

HTTP request headers

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

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

promote_shadow

object promote_shadow(name, namespace, action=action, message=message)

Promote the specified Seldon Pipeline Shadow

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
action = 'action_example' # str | Action (optional)
message = 'message_example' # str | Message (optional)

try:
    api_response = api_instance.promote_shadow(name, namespace, action=action, message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsApi->promote_shadow: %s\n" % e)

Parameters

Name Type Description Notes
name str Name identifies a resource
namespace str Namespace provides a logical grouping of resources
action str Action [optional]
message str Message [optional]

Return type

object

Authorization

OAuth2

HTTP request headers

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

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

remove_canary

object remove_canary(name, namespace, action=action, message=message)

Delete the specified Seldon Pipeline Canary

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
action = 'action_example' # str | Action (optional)
message = 'message_example' # str | Message (optional)

try:
    api_response = api_instance.remove_canary(name, namespace, action=action, message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsApi->remove_canary: %s\n" % e)

Parameters

Name Type Description Notes
name str Name identifies a resource
namespace str Namespace provides a logical grouping of resources
action str Action [optional]
message str Message [optional]

Return type

object

Authorization

OAuth2

HTTP request headers

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

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

remove_shadow

object remove_shadow(name, namespace, action=action, message=message)

Delete the specified Seldon Pipeline Shadow

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
action = 'action_example' # str | Action (optional)
message = 'message_example' # str | Message (optional)

try:
    api_response = api_instance.remove_shadow(name, namespace, action=action, message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsApi->remove_shadow: %s\n" % e)

Parameters

Name Type Description Notes
name str Name identifies a resource
namespace str Namespace provides a logical grouping of resources
action str Action [optional]
message str Message [optional]

Return type

object

Authorization

OAuth2

HTTP request headers

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

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

update_pipeline_experiment

SeldonExperiment update_pipeline_experiment(name, namespace, experiment, action=action, message=message)

Update the specified Seldon Pipeline Experiment

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
experiment = seldon_deploy_sdk.Experiment() # Experiment | Seldon Experiment
action = 'action_example' # str | Action (optional)
message = 'message_example' # str | Message (optional)

try:
    api_response = api_instance.update_pipeline_experiment(name, namespace, experiment, action=action, message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsApi->update_pipeline_experiment: %s\n" % e)

Parameters

Name Type Description Notes
name str Name identifies a resource
namespace str Namespace provides a logical grouping of resources
experiment Experiment Seldon Experiment
action str Action [optional]
message str Message [optional]

Return type

SeldonExperiment

Authorization

OAuth2

HTTP request headers

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

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