> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo/fabric/latest/reference/api/python-library-reference/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemo/fabric/_mcp/server.

# Python SDK Reference

> Complete reference for the public NeMo Fabric Python SDK.

# API Overview

## Modules

- [`nemo_fabric.client`](/nemo/fabric/reference/api/python-library-reference/client#module-nemo_fabricclient): Native Python client for resolving and running NVIDIA NeMo Fabric agents.
- [`nemo_fabric.capabilities`](/nemo/fabric/reference/api/python-library-reference/capabilities#module-nemo_fabriccapabilities): Metadata-only adapter inspection for host-side admission.
- [`nemo_fabric.check`](/nemo/fabric/reference/api/python-library-reference/check#module-nemo_fabriccheck): Health requests and immutable health reports.
- [`nemo_fabric.runtime`](/nemo/fabric/reference/api/python-library-reference/runtime#module-nemo_fabricruntime): Runtime lifecycle support for the NVIDIA NeMo Fabric Python SDK.
- [`nemo_fabric.service`](/nemo/fabric/reference/api/python-library-reference/service#module-nemo_fabricservice): Long-lived service lifecycle support for the NeMo Fabric Python SDK.
- [`nemo_fabric.streaming`](/nemo/fabric/reference/api/python-library-reference/streaming#module-nemo_fabricstreaming): NVIDIA NeMo Relay streaming support for the NVIDIA NeMo Fabric Python SDK.
- [`nemo_fabric.openai_streaming`](/nemo/fabric/reference/api/python-library-reference/openai-streaming#module-nemo_fabricopenai_streaming): Adapter-native OpenAI streaming for the NVIDIA NeMo Fabric Python SDK.
- [`nemo_fabric.models`](/nemo/fabric/reference/api/python-library-reference/models#module-nemo_fabricmodels): Pydantic SDK models for NVIDIA NeMo Fabric configuration and requests.
- [`nemo_fabric.types`](/nemo/fabric/reference/api/python-library-reference/types#module-nemo_fabrictypes): Public data contracts for the NeMo Fabric Python SDK.
- [`nemo_fabric.errors`](/nemo/fabric/reference/api/python-library-reference/errors#module-nemo_fabricerrors): Public exception hierarchy for the NeMo Fabric Python SDK.

## Classes

- [`client.Fabric`](/nemo/fabric/reference/api/python-library-reference/client#class-fabric): Primary Python entrypoint for NeMo Fabric.
- [`capabilities.AdapterCapabilityProfile`](/nemo/fabric/reference/api/python-library-reference/capabilities#class-adaptercapabilityprofile): Declared runtime support, not observed execution provenance.
- [`check.CheckReport`](/nemo/fabric/reference/api/python-library-reference/check#class-checkreport): Immutable health check report.
- [`check.CheckRequest`](/nemo/fabric/reference/api/python-library-reference/check#class-checkrequest): Select server, runtime, or registered service health.
- [`runtime.Runtime`](/nemo/fabric/reference/api/python-library-reference/runtime#class-runtime): One logical, stateful harness execution.
- [`runtime.RuntimeStatus`](/nemo/fabric/reference/api/python-library-reference/runtime#class-runtimestatus): Lifecycle state of a runtime.
- [`service.Service`](/nemo/fabric/reference/api/python-library-reference/service#class-service): One prepared or attached long-lived adapter service.
- [`service.ServiceStatus`](/nemo/fabric/reference/api/python-library-reference/service#class-servicestatus): Lifecycle state of a prepared or attached service.
- [`streaming.InvokeStream`](/nemo/fabric/reference/api/python-library-reference/streaming#class-invokestream): Async iterator of raw ATOF records for one runtime invocation.
- [`openai_streaming.OpenAIInvokeStream`](/nemo/fabric/reference/api/python-library-reference/openai-streaming#class-openaiinvokestream): Async iterator of OpenAI chat-completion chunks for one invocation.
- [`models.DiscoveryConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-discoveryconfig): Explicit local descriptor discovery paths.
- [`models.EnvironmentConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-environmentconfig): Execution environment configuration supplied by the consumer.
- [`models.FabricBaseModel`](/nemo/fabric/reference/api/python-library-reference/models#class-fabricbasemodel): Base class for SDK-facing Pydantic models.
- [`models.FabricConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-fabricconfig): SDK-facing typed NeMo Fabric agent configuration.
- [`models.HarnessConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-harnessconfig): Harness adapter selection plus adapter-owned settings.
- [`models.InstructionConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-instructionconfig): One portable instruction value.
- [`models.InstructionsConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-instructionsconfig): Harness-neutral agent instructions.
- [`models.McpAuthenticationConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-mcpauthenticationconfig): MCP server authentication configuration.
- [`models.McpConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-mcpconfig): MCP capability configuration.
- [`models.McpServerConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-mcpserverconfig): MCP server configuration.
- [`models.MetadataConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-metadataconfig): Human-readable agent identity.
- [`models.ModelConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-modelconfig): Configuration for one model role.
- [`models.ProvenanceConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-provenanceconfig): Default-on software collection and explicitly forwarded owner reports.
- [`models.RelayAtifConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-relayatifconfig): NeMo Relay ATIF export configuration.
- [`models.RelayAtofConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-relayatofconfig): NeMo Relay ATOF export configuration.
- [`models.RelayAtofFileSinkConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-relayatoffilesinkconfig): NeMo Relay ATOF file sink configuration.
- [`models.RelayAtofStreamSinkConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-relayatofstreamsinkconfig): NeMo Relay ATOF stream sink configuration.
- [`models.RelayComponentConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-relaycomponentconfig): Generic NeMo Relay plugin component configuration.
- [`models.RelayConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-relayconfig): First-class NeMo Relay integration configuration.
- [`models.RelayConfigPolicy`](/nemo/fabric/reference/api/python-library-reference/models#class-relayconfigpolicy): NeMo Relay config validation policy.
- [`models.RelayHttpStorageConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-relayhttpstorageconfig): NeMo Relay ATIF HTTP storage configuration.
- [`models.RelayObservabilityConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-relayobservabilityconfig): NeMo Relay observability component configuration.
- [`models.RelayOpenTelemetryConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-relayopentelemetryconfig): NeMo Relay typed OpenTelemetry destination configuration.
- [`models.RelayOpenTelemetryEndpointConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-relayopentelemetryendpointconfig): One typed NeMo Relay OpenTelemetry destination.
- [`models.RelayS3StorageConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-relays3storageconfig): NeMo Relay ATIF S3 storage configuration.
- [`models.RunRequest`](/nemo/fabric/reference/api/python-library-reference/models#class-runrequest): One validated NeMo Fabric invocation request.
- [`models.RuntimeConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-runtimeconfig): Invocation runtime contract.
- [`models.SkillConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-skillconfig): Skill capability configuration.
- [`models.SystemStatsConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-systemstatsconfig): Native invocation stats selection, independent of Relay and recording.
- [`models.SystemStatsSamplingConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-systemstatssamplingconfig): Opt-in periodic collection; bounds include both endpoint samples.
- [`models.TelemetryConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-telemetryconfig): Telemetry configuration.
- [`models.TelemetryProviderConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-telemetryproviderconfig): Provider-specific telemetry configuration.
- [`models.ToolDefinitionConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-tooldefinitionconfig): One named normalized tool or tool-group definition.
- [`models.ToolsConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-toolsconfig): Harness-neutral tool capability configuration.
- [`models.WorkflowConfig`](/nemo/fabric/reference/api/python-library-reference/models#class-workflowconfig): Registered workflow target and immutable construction settings.
- [`types.AdapterInfo`](/nemo/fabric/reference/api/python-library-reference/types#class-adapterinfo): Resolved adapter identity attached to a run plan.
- [`types.ArtifactManifest`](/nemo/fabric/reference/api/python-library-reference/types#class-artifactmanifest): Normalized collection of artifacts produced by a run.
- [`types.ArtifactRef`](/nemo/fabric/reference/api/python-library-reference/types#class-artifactref): Reference to one artifact produced by a run.
- [`types.CgroupObservation`](/nemo/fabric/reference/api/python-library-reference/types#class-cgroupobservation): Native cgroup snapshot or explicit unavailable/unsupported reason.
- [`types.CgroupSnapshot`](/nemo/fabric/reference/api/python-library-reference/types#class-cgroupsnapshot): Native adapter-host cgroup measurements, separate from process RSS.
- [`types.CgroupStats`](/nemo/fabric/reference/api/python-library-reference/types#class-cgroupstats): Cgroup endpoint observations and counter deltas over an invocation.
- [`types.DoctorCheck`](/nemo/fabric/reference/api/python-library-reference/types#class-doctorcheck): One diagnostic check in a ``DoctorReport``.
- [`types.DoctorReport`](/nemo/fabric/reference/api/python-library-reference/types#class-doctorreport): Aggregate preflight diagnostics for a resolved run plan.
- [`types.EnvironmentHandle`](/nemo/fabric/reference/api/python-library-reference/types#class-environmenthandle): Durable identity and provider binding for a prepared or attached environment.
- [`types.EnvironmentReference`](/nemo/fabric/reference/api/python-library-reference/types#class-environmentreference): Provider-specific identity for an existing execution environment.
- [`types.ErrorInfo`](/nemo/fabric/reference/api/python-library-reference/types#class-errorinfo): Structured failure returned inside a normalized ``RunResult``.
- [`types.ExecutionEvidence`](/nemo/fabric/reference/api/python-library-reference/types#class-executionevidence): Selected software evidence; malformed reports become explicit coverage gaps.
- [`types.FabricEvent`](/nemo/fabric/reference/api/python-library-reference/types#class-fabricevent): One normalized lifecycle or invocation event.
- [`types.GaugeSummary`](/nemo/fabric/reference/api/python-library-reference/types#class-gaugesummary): Sampled gauge extrema, hold-last-value mean, and covered time.
- [`types.InvocationSystemStats`](/nemo/fabric/reference/api/python-library-reference/types#class-invocationsystemstats): System measurements for one invocation in its executing runner.
- [`types.Measurement`](/nemo/fabric/reference/api/python-library-reference/types#class-measurement): Measured numeric value, an unlimited limit, or explicit missing evidence.
- [`types.ResourceObservation`](/nemo/fabric/reference/api/python-library-reference/types#class-resourceobservation): Adapter host process-tree reading, or an explicit collection failure.
- [`types.RunOutput`](/nemo/fabric/reference/api/python-library-reference/types#class-runoutput): Normalized adapter output.
- [`types.RunPlan`](/nemo/fabric/reference/api/python-library-reference/types#class-runplan): Immutable execution plan produced before a runtime is started.
- [`types.RunResult`](/nemo/fabric/reference/api/python-library-reference/types#class-runresult): Normalized terminal result from one NeMo Fabric invocation.
- [`types.RunUsage`](/nemo/fabric/reference/api/python-library-reference/types#class-runusage): Normalized invocation-local usage reported by an adapter target.
- [`types.RuntimeCapabilities`](/nemo/fabric/reference/api/python-library-reference/types#class-runtimecapabilities): Operations declared by the resolved runtime and adapter.
- [`types.RuntimeHandle`](/nemo/fabric/reference/api/python-library-reference/types#class-runtimehandle): Opaque identity and binding for one started runtime.
- [`types.RuntimeResourceSnapshot`](/nemo/fabric/reference/api/python-library-reference/types#class-runtimeresourcesnapshot): Timestamped resource usage of one runtime's local adapter host process tree.
- [`types.SampleSummary`](/nemo/fabric/reference/api/python-library-reference/types#class-samplesummary): Retained native series, reductions, and collection-quality diagnostics.
- [`types.ServiceHandle`](/nemo/fabric/reference/api/python-library-reference/types#class-servicehandle): Opaque identity and binding for one prepared or attached service.
- [`types.ServiceReference`](/nemo/fabric/reference/api/python-library-reference/types#class-servicereference): Reference to an already-running caller-owned service.
- [`types.SoftwareEntry`](/nemo/fabric/reference/api/python-library-reference/types#class-softwareentry): One selected software component.
- [`types.SoftwareEnvironment`](/nemo/fabric/reference/api/python-library-reference/types#class-softwareenvironment): Observed installation context and selected coverage.
- [`types.TelemetryRef`](/nemo/fabric/reference/api/python-library-reference/types#class-telemetryref): Reference to external or persisted telemetry for a run.
- [`types.VersionObservation`](/nemo/fabric/reference/api/python-library-reference/types#class-versionobservation): Read-only version observation with source, origin and original capture time.
- [`errors.FabricCapabilityError`](/nemo/fabric/reference/api/python-library-reference/errors#class-fabriccapabilityerror): Operation rejected by resolved runtime capabilities or implementation status.
- [`errors.FabricConfigError`](/nemo/fabric/reference/api/python-library-reference/errors#class-fabricconfigerror): Invalid SDK input, request shape, factory, or resolved config.
- [`errors.FabricError`](/nemo/fabric/reference/api/python-library-reference/errors#class-fabricerror): Base class for structured SDK-level NeMo Fabric errors.
- [`errors.FabricNativeUnavailableError`](/nemo/fabric/reference/api/python-library-reference/errors#class-fabricnativeunavailableerror): SDK call requires the PyO3 extension, but it is not installed or importable.
- [`errors.FabricRuntimeError`](/nemo/fabric/reference/api/python-library-reference/errors#class-fabricruntimeerror): Failure while starting, invoking, stopping, or otherwise driving a runtime.
- [`errors.FabricStateError`](/nemo/fabric/reference/api/python-library-reference/errors#class-fabricstateerror): Operation rejected because a local runtime is in the wrong state.
- [`errors.ResourceObservationUnavailableError`](/nemo/fabric/reference/api/python-library-reference/errors#class-resourceobservationunavailableerror): Runtime resources cannot be read now.
- [`errors.ResourceObservationUnsupportedError`](/nemo/fabric/reference/api/python-library-reference/errors#class-resourceobservationunsupportederror): Runtime resources have no reader.

## Functions

- [`capabilities.inspect_adapter`](/nemo/fabric/reference/api/python-library-reference/capabilities#function-inspect_adapter): Inspect supplied adapter and optional workflow metadata without loading its SDK.


---

_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._

> Complete reference for the public NeMo Fabric Python SDK.