`nemo_microservices.resources.evaluation.results`#

Module Contents#

Classes#

`AsyncResultsResource`
`AsyncResultsResourceWithRawResponse`
`AsyncResultsResourceWithStreamingResponse`
`ResultsResource`
`ResultsResourceWithRawResponse`
`ResultsResourceWithStreamingResponse`

API#

class nemo_microservices.resources.evaluation.results.AsyncResultsResource( client: nemo_microservices._client.AsyncNeMoMicroservices, )#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

async create( *, job: str, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, files_url: str | nemo_microservices._types.Omit = omit, groups: Dict[str, nemo_microservices.types.evaluation.group_result_param.GroupResultParam] | nemo_microservices._types.Omit = omit, namespace: str | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, tasks: Dict[str, nemo_microservices.types.evaluation.task_result_param.TaskResultParam] | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.evaluation_result.EvaluationResult#

Create a new evaluation result.

Args: job: The evaluation job associated with this results instance.

custom_fields: A set of custom fields that the user can define and use for various purposes.

description: The description of the entity.

files_url: The place for the output files, if any.

groups: The results at the group-level.

namespace: The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

ownership: Information about ownership of an entity.

  If the entity is a namespace, the `access_policies` will typically apply to all
  entities inside the namespace.

project: The URN of the project associated with this entity.

tasks: The results at the task-level.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async delete( result_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.shared.delete_response.DeleteResponse#

Delete Evaluation Result

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

List available evaluation results.

Args: filter: Filter results on various criteria.

page: Page number.

page_size: Page size.

search: Search evaluation results using substring matching. You can combine multiple search fields and filters.

  For example:

  - `?search[job]=eval-2024-01-15`: searches all results with 'eval-2024-01-15' in
    the job field.
  - `?search[tasks]=classification`: searches all results with 'classification' in
    the tasks.
  - `?search[groups]=accuracy`: searches all results with 'accuracy' in the
    groups.
  - `?search[job]=eval-2024-01-15&search[tasks]=classification`: searches all
    results with 'eval-2024-01-15' in the job field AND 'classification' in the
    tasks.
  - `?search[updated_at][start]=2024-01-01T00:00:00` finds all results updated on
    or after the start date
  - `?search[created_at][start]=2022-01-01&search[updated_at][end]=2024-01-01`
    finds all results created from start date up to and including end date

sort: The field to sort by. To sort in decreasing order, use - in front of the field name.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async retrieve( result_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.evaluation_result.EvaluationResult#

Get evaluation result info.

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async update( result_id: str, *, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, files_url: str | nemo_microservices._types.Omit = omit, groups: Dict[str, nemo_microservices.types.evaluation.group_result_param.GroupResultParam] | nemo_microservices._types.Omit = omit, job: str | nemo_microservices._types.Omit = omit, namespace: str | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, tasks: Dict[str, nemo_microservices.types.evaluation.task_result_param.TaskResultParam] | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.evaluation_result.EvaluationResult#

Update the evaluation result.

Args: custom_fields: A set of custom fields that the user can define and use for various purposes.

description: The description of the entity.

files_url: The place for the output files, if any.

groups: The results at the group-level.

job: The evaluation job associated with this results instance.

namespace: The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

ownership: Information about ownership of an entity.

  If the entity is a namespace, the `access_policies` will typically apply to all
  entities inside the namespace.

project: The URN of the project associated with this entity.

tasks: The results at the task-level.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property with_raw_response: nemo_microservices.resources.evaluation.results.AsyncResultsResourceWithRawResponse#

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: nemo_microservices.resources.evaluation.results.AsyncResultsResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

class nemo_microservices.resources.evaluation.results.AsyncResultsResourceWithRawResponse( results: nemo_microservices.resources.evaluation.results.AsyncResultsResource, )#: Initialization

class nemo_microservices.resources.evaluation.results.AsyncResultsResourceWithStreamingResponse( results: nemo_microservices.resources.evaluation.results.AsyncResultsResource, )#: Initialization

class nemo_microservices.resources.evaluation.results.ResultsResource(client: nemo_microservices._client.NeMoMicroservices)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

create( *, job: str, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, files_url: str | nemo_microservices._types.Omit = omit, groups: Dict[str, nemo_microservices.types.evaluation.group_result_param.GroupResultParam] | nemo_microservices._types.Omit = omit, namespace: str | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, tasks: Dict[str, nemo_microservices.types.evaluation.task_result_param.TaskResultParam] | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.evaluation_result.EvaluationResult#

Create a new evaluation result.

Args: job: The evaluation job associated with this results instance.

custom_fields: A set of custom fields that the user can define and use for various purposes.

description: The description of the entity.

files_url: The place for the output files, if any.

groups: The results at the group-level.

namespace: The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

ownership: Information about ownership of an entity.

  If the entity is a namespace, the `access_policies` will typically apply to all
  entities inside the namespace.

project: The URN of the project associated with this entity.

tasks: The results at the task-level.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

delete( result_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.shared.delete_response.DeleteResponse#

Delete Evaluation Result

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

List available evaluation results.

Args: filter: Filter results on various criteria.

page: Page number.

page_size: Page size.

search: Search evaluation results using substring matching. You can combine multiple search fields and filters.

  For example:

  - `?search[job]=eval-2024-01-15`: searches all results with 'eval-2024-01-15' in
    the job field.
  - `?search[tasks]=classification`: searches all results with 'classification' in
    the tasks.
  - `?search[groups]=accuracy`: searches all results with 'accuracy' in the
    groups.
  - `?search[job]=eval-2024-01-15&search[tasks]=classification`: searches all
    results with 'eval-2024-01-15' in the job field AND 'classification' in the
    tasks.
  - `?search[updated_at][start]=2024-01-01T00:00:00` finds all results updated on
    or after the start date
  - `?search[created_at][start]=2022-01-01&search[updated_at][end]=2024-01-01`
    finds all results created from start date up to and including end date

sort: The field to sort by. To sort in decreasing order, use - in front of the field name.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

retrieve( result_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.evaluation_result.EvaluationResult#

Get evaluation result info.

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

update( result_id: str, *, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, files_url: str | nemo_microservices._types.Omit = omit, groups: Dict[str, nemo_microservices.types.evaluation.group_result_param.GroupResultParam] | nemo_microservices._types.Omit = omit, job: str | nemo_microservices._types.Omit = omit, namespace: str | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, tasks: Dict[str, nemo_microservices.types.evaluation.task_result_param.TaskResultParam] | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.evaluation_result.EvaluationResult#

Update the evaluation result.

Args: custom_fields: A set of custom fields that the user can define and use for various purposes.

description: The description of the entity.

files_url: The place for the output files, if any.

groups: The results at the group-level.

job: The evaluation job associated with this results instance.

namespace: The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

ownership: Information about ownership of an entity.

  If the entity is a namespace, the `access_policies` will typically apply to all
  entities inside the namespace.

project: The URN of the project associated with this entity.

tasks: The results at the task-level.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property with_raw_response: nemo_microservices.resources.evaluation.results.ResultsResourceWithRawResponse#

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: nemo_microservices.resources.evaluation.results.ResultsResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

class nemo_microservices.resources.evaluation.results.ResultsResourceWithRawResponse( results: nemo_microservices.resources.evaluation.results.ResultsResource, )#: Initialization

class nemo_microservices.resources.evaluation.results.ResultsResourceWithStreamingResponse( results: nemo_microservices.resources.evaluation.results.ResultsResource, )#: Initialization

nemo_microservices.resources.evaluation.results#

Module Contents#

Classes#

API#

`nemo_microservices.resources.evaluation.results`#