mistk.model.client.api.model_instance_endpoint_api module

Model Integration Software ToolKit

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 1.0.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class mistk.model.client.api.model_instance_endpoint_api.ModelInstanceEndpointApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

build_model(**kwargs)

Build the model # noqa: E501

Instructs the container to construct the model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.build_model(async_req=True) >>> result = thread.get()

:param async_req bool :param str model_path: The absolute path to the directory where the model’s checkpoint/snapshot file can be found. :return: None

If the method is called asynchronously, returns the request thread.

build_model_with_http_info(**kwargs)

Build the model # noqa: E501

Instructs the container to construct the model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.build_model_with_http_info(async_req=True) >>> result = thread.get()

:param async_req bool :param str model_path: The absolute path to the directory where the model’s checkpoint/snapshot file can be found. :return: None

If the method is called asynchronously, returns the request thread.

generate(**kwargs)

Perform generations with the model # noqa: E501

Perform generations with the model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

generate_with_http_info(**kwargs)

Perform generations with the model # noqa: E501

Perform generations with the model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_with_http_info(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

get_api_version(**kwargs)

Returns the version of the MISTK API # noqa: E501

Returns the version of the MISTK API # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_api_version(async_req=True) >>> result = thread.get()

:param async_req bool :return: str

If the method is called asynchronously, returns the request thread.

get_api_version_with_http_info(**kwargs)

Returns the version of the MISTK API # noqa: E501

Returns the version of the MISTK API # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_api_version_with_http_info(async_req=True) >>> result = thread.get()

:param async_req bool :return: str

If the method is called asynchronously, returns the request thread.

get_status(**kwargs)

Get the status of the model # noqa: E501

Retrieves the current status of the model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_status(async_req=True) >>> result = thread.get()

:param async_req bool :param bool watch: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. :param int resource_version: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. :return: ModelInstanceStatus

If the method is called asynchronously, returns the request thread.

get_status_with_http_info(**kwargs)

Get the status of the model # noqa: E501

Retrieves the current status of the model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_status_with_http_info(async_req=True) >>> result = thread.get()

:param async_req bool :param bool watch: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. :param int resource_version: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. :return: ModelInstanceStatus

If the method is called asynchronously, returns the request thread.

initialize_model(initialization_parameters, **kwargs)

Initialize the model # noqa: E501

Instructs the model instance to initialize. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.initialize_model(initialization_parameters, async_req=True) >>> result = thread.get()

:param async_req bool :param ModelInstanceInitParams initialization_parameters: Initialization parameters for the model including the objectives, properties, and hparams. Objectives are a list of objectives for this model instance from the following options {train, predict, stream_predict, generate, transfer_learning}. Properties are a dictionary of properties for this model instance. Hparams are a dictionary of hyperparameters for this model instance. (required) :return: None

If the method is called asynchronously, returns the request thread.

initialize_model_with_http_info(initialization_parameters, **kwargs)

Initialize the model # noqa: E501

Instructs the model instance to initialize. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.initialize_model_with_http_info(initialization_parameters, async_req=True) >>> result = thread.get()

:param async_req bool :param ModelInstanceInitParams initialization_parameters: Initialization parameters for the model including the objectives, properties, and hparams. Objectives are a list of objectives for this model instance from the following options {train, predict, stream_predict, generate, transfer_learning}. Properties are a dictionary of properties for this model instance. Hparams are a dictionary of hyperparameters for this model instance. (required) :return: None

If the method is called asynchronously, returns the request thread.

load_data(datasets, **kwargs)

Loads data for the model # noqa: E501

Loads data onto a staging area for use by the model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.load_data(datasets, async_req=True) >>> result = thread.get()

:param async_req bool :param object datasets: A dictionary mapping objectives to MistkDataset objects. Dictionary keys must be one of the following {train, test, generate} (required) :return: None

If the method is called asynchronously, returns the request thread.

load_data_with_http_info(datasets, **kwargs)

Loads data for the model # noqa: E501

Loads data onto a staging area for use by the model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.load_data_with_http_info(datasets, async_req=True) >>> result = thread.get()

:param async_req bool :param object datasets: A dictionary mapping objectives to MistkDataset objects. Dictionary keys must be one of the following {train, test, generate} (required) :return: None

If the method is called asynchronously, returns the request thread.

pause(**kwargs)

Pause the model # noqa: E501

Instructs the container to pause the current training or prediction activity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.pause(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

pause_with_http_info(**kwargs)

Pause the model # noqa: E501

Instructs the container to pause the current training or prediction activity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.pause_with_http_info(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

predict(**kwargs)

Perform predictions with the model # noqa: E501

Perform predictions with the test dataset previously loaded # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.predict(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

predict_with_http_info(**kwargs)

Perform predictions with the model # noqa: E501

Perform predictions with the test dataset previously loaded # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.predict_with_http_info(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

reset(**kwargs)

Resets the model # noqa: E501

Resets the model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.reset(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

reset_with_http_info(**kwargs)

Resets the model # noqa: E501

Resets the model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.reset_with_http_info(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

resume_predict(**kwargs)

Resume predicitons on a paused model # noqa: E501

Resumes the training activity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.resume_predict(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

resume_predict_with_http_info(**kwargs)

Resume predicitons on a paused model # noqa: E501

Resumes the training activity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.resume_predict_with_http_info(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

resume_training(**kwargs)

Resume training on a paused model # noqa: E501

Resumes the training activity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.resume_training(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

resume_training_with_http_info(**kwargs)

Resume training on a paused model # noqa: E501

Resumes the training activity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.resume_training_with_http_info(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

save_generations(data_path, **kwargs)

Save the generations made by the model # noqa: E501

Instructs the container to save the generations to the specified path # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.save_generations(data_path, async_req=True) >>> result = thread.get()

:param async_req bool :param str data_path: A path pointing to the directory where the generations are to be saved. (required) :return: None

If the method is called asynchronously, returns the request thread.

save_generations_with_http_info(data_path, **kwargs)

Save the generations made by the model # noqa: E501

Instructs the container to save the generations to the specified path # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.save_generations_with_http_info(data_path, async_req=True) >>> result = thread.get()

:param async_req bool :param str data_path: A path pointing to the directory where the generations are to be saved. (required) :return: None

If the method is called asynchronously, returns the request thread.

save_model(model_path, **kwargs)

Save the model snapshot # noqa: E501

Instructs the container to serialize the model to the specified path # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.save_model(model_path, async_req=True) >>> result = thread.get()

:param async_req bool :param str model_path: A path pointing to the directory where the model is to be saved. (required) :return: None

If the method is called asynchronously, returns the request thread.

save_model_with_http_info(model_path, **kwargs)

Save the model snapshot # noqa: E501

Instructs the container to serialize the model to the specified path # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.save_model_with_http_info(model_path, async_req=True) >>> result = thread.get()

:param async_req bool :param str model_path: A path pointing to the directory where the model is to be saved. (required) :return: None

If the method is called asynchronously, returns the request thread.

save_predictions(data_path, **kwargs)

Save the predictions made by the model # noqa: E501

Instructs the container to save the predictions to the specified path # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.save_predictions(data_path, async_req=True) >>> result = thread.get()

:param async_req bool :param str data_path: A path pointing to the directory where the predictions are to be saved. (required) :return: None

If the method is called asynchronously, returns the request thread.

save_predictions_with_http_info(data_path, **kwargs)

Save the predictions made by the model # noqa: E501

Instructs the container to save the predictions to the specified path # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.save_predictions_with_http_info(data_path, async_req=True) >>> result = thread.get()

:param async_req bool :param str data_path: A path pointing to the directory where the predictions are to be saved. (required) :return: None

If the method is called asynchronously, returns the request thread.

stream_predict(data_map, **kwargs)

Perform streaming predictions with the model # noqa: E501

Perform predictions with the test dataset previously loaded # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.stream_predict(data_map, async_req=True) >>> result = thread.get()

:param async_req bool :param object data_map: Dictionary of IDs to b64 encoded data (required) :param bool details: Boolean flag to indicate whether prediction details (markdown) should be included in predictions dictionary. :return: dict(str, object)

If the method is called asynchronously, returns the request thread.

stream_predict_with_http_info(data_map, **kwargs)

Perform streaming predictions with the model # noqa: E501

Perform predictions with the test dataset previously loaded # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.stream_predict_with_http_info(data_map, async_req=True) >>> result = thread.get()

:param async_req bool :param object data_map: Dictionary of IDs to b64 encoded data (required) :param bool details: Boolean flag to indicate whether prediction details (markdown) should be included in predictions dictionary. :return: dict(str, object)

If the method is called asynchronously, returns the request thread.

terminate(**kwargs)

Shut down the model # noqa: E501

Shuts down the model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.terminate(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

terminate_with_http_info(**kwargs)

Shut down the model # noqa: E501

Shuts down the model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.terminate_with_http_info(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

train(**kwargs)

Train the model # noqa: E501

Trains the model with the training dataset previously loaded # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.train(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

train_with_http_info(**kwargs)

Train the model # noqa: E501

Trains the model with the training dataset previously loaded # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.train_with_http_info(async_req=True) >>> result = thread.get()

:param async_req bool :return: None

If the method is called asynchronously, returns the request thread.

update_stream_properties(props, **kwargs)

Updates streaming properties with the model # noqa: E501

Update streaming properties # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_stream_properties(props, async_req=True) >>> result = thread.get()

:param async_req bool :param object props: Dictionary of metadata properties to be used by the model (required) :return: None

If the method is called asynchronously, returns the request thread.

update_stream_properties_with_http_info(props, **kwargs)

Updates streaming properties with the model # noqa: E501

Update streaming properties # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_stream_properties_with_http_info(props, async_req=True) >>> result = thread.get()

:param async_req bool :param object props: Dictionary of metadata properties to be used by the model (required) :return: None

If the method is called asynchronously, returns the request thread.