nemo_microservices.resources.evaluation.evaluation#

Module Contents#

Classes#

API#

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

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

property configs: nemo_microservices.resources.evaluation.configs.AsyncConfigsResource#
property jobs: nemo_microservices.resources.evaluation.jobs.AsyncJobsResource#
async live(
*,
config: nemo_microservices.types.evaluation_live_params.Config,
target: nemo_microservices.types.evaluation_live_params.Target,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
namespace: str | nemo_microservices._types.Omit = omit,
output_files_url: 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,
result: str | nemo_microservices._types.Omit = omit,
status: nemo_microservices.types.shared.job_status.JobStatus | nemo_microservices._types.Omit = omit,
status_details: nemo_microservices.types.evaluation_status_details_param.EvaluationStatusDetailsParam | 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.live_evaluation.LiveEvaluation#

Start a live evaluation.

Similar to starting an evaluation job, but waits and returns the results. Not evaluation job is persisted.

Args: config: The evaluation configuration.

target: The evaluation target.

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

description: The description of the entity.

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

output_files_url: The place where the output files, if any, should be written.

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.

result: The evaluation result URN.

status: Normalized statuses for all jobs.

  - **CREATED**: The job is created, but not yet scheduled.
  - **PENDING**: The job is waiting for resource allocation.
  - **RUNNING**: The job is currently running.
  - **CANCELLING**: The job is being cancelled at the user's request.
  - **CANCELLED**: The job has been cancelled by the user.
  - **CANCELLING**: The job is being cancelled at the user's request.
  - **FAILED**: The job failed to execute and terminated.
  - **COMPLETED**: The job has completed successfully.
  - **READY**: The job is ready to be used.
  - **UNKNOWN**: The job status is unknown.

status_details: Details about the status of the evaluation.

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 results: nemo_microservices.resources.evaluation.results.AsyncResultsResource#
property targets: nemo_microservices.resources.evaluation.targets.AsyncTargetsResource#
property with_raw_response: nemo_microservices.resources.evaluation.evaluation.AsyncEvaluationResourceWithRawResponse#

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.evaluation.AsyncEvaluationResourceWithStreamingResponse#

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.evaluation.AsyncEvaluationResourceWithRawResponse(
evaluation: nemo_microservices.resources.evaluation.evaluation.AsyncEvaluationResource,
)#

Initialization

property configs: nemo_microservices.resources.evaluation.configs.AsyncConfigsResourceWithRawResponse#
property jobs: nemo_microservices.resources.evaluation.jobs.AsyncJobsResourceWithRawResponse#
property results: nemo_microservices.resources.evaluation.results.AsyncResultsResourceWithRawResponse#
property targets: nemo_microservices.resources.evaluation.targets.AsyncTargetsResourceWithRawResponse#
class nemo_microservices.resources.evaluation.evaluation.AsyncEvaluationResourceWithStreamingResponse(
evaluation: nemo_microservices.resources.evaluation.evaluation.AsyncEvaluationResource,
)#

Initialization

property configs: nemo_microservices.resources.evaluation.configs.AsyncConfigsResourceWithStreamingResponse#
property jobs: nemo_microservices.resources.evaluation.jobs.AsyncJobsResourceWithStreamingResponse#
property results: nemo_microservices.resources.evaluation.results.AsyncResultsResourceWithStreamingResponse#
property targets: nemo_microservices.resources.evaluation.targets.AsyncTargetsResourceWithStreamingResponse#
class nemo_microservices.resources.evaluation.evaluation.EvaluationResource(
client: nemo_microservices._client.NeMoMicroservices,
)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

property configs: nemo_microservices.resources.evaluation.configs.ConfigsResource#
property jobs: nemo_microservices.resources.evaluation.jobs.JobsResource#
live(
*,
config: nemo_microservices.types.evaluation_live_params.Config,
target: nemo_microservices.types.evaluation_live_params.Target,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
namespace: str | nemo_microservices._types.Omit = omit,
output_files_url: 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,
result: str | nemo_microservices._types.Omit = omit,
status: nemo_microservices.types.shared.job_status.JobStatus | nemo_microservices._types.Omit = omit,
status_details: nemo_microservices.types.evaluation_status_details_param.EvaluationStatusDetailsParam | 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.live_evaluation.LiveEvaluation#

Start a live evaluation.

Similar to starting an evaluation job, but waits and returns the results. Not evaluation job is persisted.

Args: config: The evaluation configuration.

target: The evaluation target.

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

description: The description of the entity.

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

output_files_url: The place where the output files, if any, should be written.

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.

result: The evaluation result URN.

status: Normalized statuses for all jobs.

  - **CREATED**: The job is created, but not yet scheduled.
  - **PENDING**: The job is waiting for resource allocation.
  - **RUNNING**: The job is currently running.
  - **CANCELLING**: The job is being cancelled at the user's request.
  - **CANCELLED**: The job has been cancelled by the user.
  - **CANCELLING**: The job is being cancelled at the user's request.
  - **FAILED**: The job failed to execute and terminated.
  - **COMPLETED**: The job has completed successfully.
  - **READY**: The job is ready to be used.
  - **UNKNOWN**: The job status is unknown.

status_details: Details about the status of the evaluation.

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 results: nemo_microservices.resources.evaluation.results.ResultsResource#
property targets: nemo_microservices.resources.evaluation.targets.TargetsResource#
property with_raw_response: nemo_microservices.resources.evaluation.evaluation.EvaluationResourceWithRawResponse#

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.evaluation.EvaluationResourceWithStreamingResponse#

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.evaluation.EvaluationResourceWithRawResponse(
evaluation: nemo_microservices.resources.evaluation.evaluation.EvaluationResource,
)#

Initialization

property configs: nemo_microservices.resources.evaluation.configs.ConfigsResourceWithRawResponse#
property jobs: nemo_microservices.resources.evaluation.jobs.JobsResourceWithRawResponse#
property results: nemo_microservices.resources.evaluation.results.ResultsResourceWithRawResponse#
property targets: nemo_microservices.resources.evaluation.targets.TargetsResourceWithRawResponse#
class nemo_microservices.resources.evaluation.evaluation.EvaluationResourceWithStreamingResponse(
evaluation: nemo_microservices.resources.evaluation.evaluation.EvaluationResource,
)#

Initialization

property configs: nemo_microservices.resources.evaluation.configs.ConfigsResourceWithStreamingResponse#
property jobs: nemo_microservices.resources.evaluation.jobs.JobsResourceWithStreamingResponse#
property results: nemo_microservices.resources.evaluation.results.ResultsResourceWithStreamingResponse#
property targets: nemo_microservices.resources.evaluation.targets.TargetsResourceWithStreamingResponse#