mistk.evaluation.client.api.evaluation_plugin_endpoint_api module

Model Integration Software ToolKit - Metric Evaluation

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.evaluation.client.api.evaluation_plugin_endpoint_api.EvaluationPluginEndpointApi(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

evaluate(init_params, **kwargs)

Performs the evaluation defined for this plugin # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.evaluate(init_params, async_req=True) >>> result = thread.get()

:param async_req bool :param EvaluationSpecificationInitParams init_params: A list of metrics to run and ground truth and prediction file paths to run the metrics against (required) :return: None

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

evaluate_with_http_info(init_params, **kwargs)

Performs the evaluation defined for this plugin # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.evaluate_with_http_info(init_params, async_req=True) >>> result = thread.get()

:param async_req bool :param EvaluationSpecificationInitParams init_params: A list of metrics to run and ground truth and prediction file paths to run the metrics against (required) :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: None

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: None

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

get_metrics(**kwargs)

Retrieves the metrics available to perform for the evaluation plugin # 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_metrics(async_req=True) >>> result = thread.get()

:param async_req bool :return: list[MistkMetric]

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

get_metrics_with_http_info(**kwargs)

Retrieves the metrics available to perform for the evaluation plugin # 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_metrics_with_http_info(async_req=True) >>> result = thread.get()

:param async_req bool :return: list[MistkMetric]

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

get_status(**kwargs)

Retrieves the status of the evaluation plugin # 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 float 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: EvaluationInstanceStatus

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

get_status_with_http_info(**kwargs)

Retrieves the status of the evaluation plugin # 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 float 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: EvaluationInstanceStatus

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

terminate(**kwargs)

Shutdowns the evaluation plugin and cleans up any resources. # 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)

Shutdowns the evaluation plugin and cleans up any resources. # 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.