benchmark_jobs.benchmark_jobs#

Module Contents#

Classes#

API#

class benchmark_jobs.benchmark_jobs.AsyncBenchmarkJobsResource(
client: nemo_platform._client.AsyncNeMoPlatform,
)#

Bases: nemo_platform._resource.AsyncAPIResource

Initialization

async cancel(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.benchmark_evaluation_job.BenchmarkEvaluationJob#
async create(
*,
workspace: str | None = None,
spec: nemo_platform.types.benchmark_job_create_params.Spec,
custom_fields: Dict[str, object] | nemo_platform._types.Omit = omit,
description: str | nemo_platform._types.Omit = omit,
name: str | nemo_platform._types.Omit = omit,
ownership: Dict[str, object] | nemo_platform._types.Omit = omit,
project: str | nemo_platform._types.Omit = omit,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.benchmark_evaluation_job.BenchmarkEvaluationJob#
async delete(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) None#
get_logs(
name: str,
*,
workspace: str | None = None,
limit: int | nemo_platform._types.Omit = omit,
page_cursor: str | nemo_platform._types.Omit = omit,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform._base_client.AsyncPaginator[nemo_platform.types.shared.platform_job_log.PlatformJobLog, nemo_platform.pagination.AsyncLogsPagination[nemo_platform.types.shared.platform_job_log.PlatformJobLog]]#
async get_status(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.shared.platform_job_status_response.PlatformJobStatusResponse#
list(
*,
workspace: str | None = None,
filter: nemo_platform.types.benchmark_evaluation_jobs_list_filter_param.BenchmarkEvaluationJobsListFilterParam | nemo_platform._types.Omit = omit,
page: int | nemo_platform._types.Omit = omit,
page_size: int | nemo_platform._types.Omit = omit,
search: nemo_platform.types.benchmark_evaluation_jobs_search_param.BenchmarkEvaluationJobsSearchParam | nemo_platform._types.Omit = omit,
sort: nemo_platform.types.benchmark_evaluation_jobs_sort_field.BenchmarkEvaluationJobsSortField | nemo_platform._types.Omit = omit,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform._base_client.AsyncPaginator[nemo_platform.types.benchmark_evaluation_job.BenchmarkEvaluationJob, nemo_platform.pagination.AsyncDefaultPagination[nemo_platform.types.benchmark_evaluation_job.BenchmarkEvaluationJob]]#
property results: benchmark_jobs.results.results.AsyncResultsResource#
async retrieve(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.benchmark_evaluation_job.BenchmarkEvaluationJob#
property with_raw_response: benchmark_jobs.benchmark_jobs.AsyncBenchmarkJobsResourceWithRawResponse#
property with_streaming_response: benchmark_jobs.benchmark_jobs.AsyncBenchmarkJobsResourceWithStreamingResponse#
class benchmark_jobs.benchmark_jobs.AsyncBenchmarkJobsResourceWithRawResponse(
benchmark_jobs: benchmark_jobs.benchmark_jobs.AsyncBenchmarkJobsResource,
)#

Initialization

property results: benchmark_jobs.results.results.AsyncResultsResourceWithRawResponse#
class benchmark_jobs.benchmark_jobs.AsyncBenchmarkJobsResourceWithStreamingResponse(
benchmark_jobs: benchmark_jobs.benchmark_jobs.AsyncBenchmarkJobsResource,
)#

Initialization

property results: benchmark_jobs.results.results.AsyncResultsResourceWithStreamingResponse#
class benchmark_jobs.benchmark_jobs.BenchmarkJobsResource(client: nemo_platform._client.NeMoPlatform)#

Bases: nemo_platform._resource.SyncAPIResource

Initialization

cancel(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.benchmark_evaluation_job.BenchmarkEvaluationJob#
create(
*,
workspace: str | None = None,
spec: nemo_platform.types.benchmark_job_create_params.Spec,
custom_fields: Dict[str, object] | nemo_platform._types.Omit = omit,
description: str | nemo_platform._types.Omit = omit,
name: str | nemo_platform._types.Omit = omit,
ownership: Dict[str, object] | nemo_platform._types.Omit = omit,
project: str | nemo_platform._types.Omit = omit,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.benchmark_evaluation_job.BenchmarkEvaluationJob#
delete(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) None#
get_logs(
name: str,
*,
workspace: str | None = None,
limit: int | nemo_platform._types.Omit = omit,
page_cursor: str | nemo_platform._types.Omit = omit,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.pagination.SyncLogsPagination[nemo_platform.types.shared.platform_job_log.PlatformJobLog]#
get_status(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.shared.platform_job_status_response.PlatformJobStatusResponse#
list(
*,
workspace: str | None = None,
filter: nemo_platform.types.benchmark_evaluation_jobs_list_filter_param.BenchmarkEvaluationJobsListFilterParam | nemo_platform._types.Omit = omit,
page: int | nemo_platform._types.Omit = omit,
page_size: int | nemo_platform._types.Omit = omit,
search: nemo_platform.types.benchmark_evaluation_jobs_search_param.BenchmarkEvaluationJobsSearchParam | nemo_platform._types.Omit = omit,
sort: nemo_platform.types.benchmark_evaluation_jobs_sort_field.BenchmarkEvaluationJobsSortField | nemo_platform._types.Omit = omit,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.pagination.SyncDefaultPagination[nemo_platform.types.benchmark_evaluation_job.BenchmarkEvaluationJob]#
property results: benchmark_jobs.results.results.ResultsResource#
retrieve(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.benchmark_evaluation_job.BenchmarkEvaluationJob#
property with_raw_response: benchmark_jobs.benchmark_jobs.BenchmarkJobsResourceWithRawResponse#
property with_streaming_response: benchmark_jobs.benchmark_jobs.BenchmarkJobsResourceWithStreamingResponse#
class benchmark_jobs.benchmark_jobs.BenchmarkJobsResourceWithRawResponse(
benchmark_jobs: benchmark_jobs.benchmark_jobs.BenchmarkJobsResource,
)#

Initialization

property results: benchmark_jobs.results.results.ResultsResourceWithRawResponse#
class benchmark_jobs.benchmark_jobs.BenchmarkJobsResourceWithStreamingResponse(
benchmark_jobs: benchmark_jobs.benchmark_jobs.BenchmarkJobsResource,
)#

Initialization

property results: benchmark_jobs.results.results.ResultsResourceWithStreamingResponse#