gpu_decoder_configs¶

Client API for gpu decoder configs in Nexus.

qnexus.client.gpu_decoder_configs.get( *, id: UUID | str | None = None, name: str | None = None, name_like: str | None = None, creator_email: list[str] | None = None, project: ProjectRef | None = None, properties: OrderedDict[str, bool | int | float | str] | None = None, created_before: datetime | None = None, created_after: datetime | None = datetime.datetime(2023, 1, 1, 0, 0), modified_before: datetime | None = None, modified_after: datetime | None = None, sort_filters: list[SortFilterEnum] | None = None, page_number: int | None = None, page_size: int | None = None, scope: ScopeFilterEnum = ScopeFilterEnum.USER, ) → GpuDecoderConfigRef[source]¶

Get a single gpu_decoder_config using filters. Throws an exception if the filters do not match exactly one object.

Examples

>>> import qnexus as qnx
>>> config_ref = qnx.gpu_decoder_configs.get(name="my_config")

qnexus.client.gpu_decoder_configs.get_all( *, name_like: str | None = None, name_exact: list[str] | None = None, creator_email: list[str] | None = None, project: ProjectRef | None = None, properties: OrderedDict[str, bool | int | float | str] | None = None, created_before: datetime | None = None, created_after: datetime | None = datetime.datetime(2023, 1, 1, 0, 0), modified_before: datetime | None = None, modified_after: datetime | None = None, sort_filters: list[SortFilterEnum] | None = None, page_number: int | None = None, page_size: int | None = None, scope: ScopeFilterEnum = ScopeFilterEnum.USER, ) → NexusIterator[GpuDecoderConfigRef][source]¶

Get a NexusIterator over gpu decoder configs with optional filters.

Examples

>>> import qnexus as qnx
>>> all_configs = qnx.gpu_decoder_configs.get_all()
>>> all_configs.df()

>>> project_configs = qnx.gpu_decoder_configs.get_all(
...     name_like="my_config",
...     project=my_project_ref,
... )

qnexus.client.gpu_decoder_configs.update( ref: GpuDecoderConfigRef, name: str | None = None, description: str | None = None, properties: OrderedDict[str, bool | int | float | str] | None = None, ) → GpuDecoderConfigRef[source]¶

Update the annotations on a GpuDecoderConfigRef.

Examples

>>> import qnexus as qnx
>>> updated_ref = qnx.gpu_decoder_configs.update(
...     config_ref,
...     name="renamed_config",
... )

qnexus.client.gpu_decoder_configs.upload( gpu_decoder_config: str, project: ProjectRef | None = None, name: str | None = None, description: str | None = None, properties: OrderedDict[str, bool | int | float | str] | None = None, ) → GpuDecoderConfigRef[source]¶

Upload a pytket GpuDecoderConfig to Nexus.

Examples

>>> import qnexus as qnx
>>> config_ref = qnx.gpu_decoder_configs.upload(
...     gpu_decoder_config=config_string,
...     name="my_config",
...     project=my_project_ref,
... )