sdkagent

wandb API reference

400 public APIs from wandb (wandb/wandb) — 104 classes, 102 functions, 194 methods. Signatures extracted by static analysis of the actual source.

Repository: wandb/wandb

KindCount
Classes104
Functions102
Methods194

API list

funccore.hatch.build_wandb_core(go_binary:pathlib.Path, output_path:pathlib.PurePath, with_code_coverage:bool, with_race_detection:bool, with_cgo:bool, wandb_commit_sha:str | None, target_system, target_arch) -> None
Builds the wandb-core Go module.
classparquet-rust-wrapper.hatch.ArrowRsWrapperBuildError
Raised when building arrow-rs-wrapper fails.
funcparquet-rust-wrapper.hatch.build_arrow_rs_wrapper(cargo_binary:pathlib.Path, output_path:pathlib.Path, target_triple:str | None=None) -> None
Build the arrow-rs-wrapper Rust library.
classwandb._filters.expressions.FilterExpr
A MongoDB filter expression on a specific field.
funcwandb._iterutils.one(iterable:Iterable[T], too_short:type[Exception] | Exception | None=None, too_long:type[Exception] | Exception | None=None) -> T
Return the only item in the iterable.
methodwandb._pydantic.pagination.Connection.has_next() -> bool
Returns True if there are more pages to fetch.
methodwandb._pydantic.pagination.Connection.nodes() -> Iterator[NodeT]
Returns an iterator over the nodes in the connection.
classwandb._pydantic.pagination.Edge
A wrapper around a single result item in a paginated response.
funcwandb._pydantic.utils.from_json(s:str | bytes) -> Any
Quickly deserialize a JSON string to a Python object.
funcwandb._pydantic.utils.gql_typename(cls:type[BaseModel]) -> str
Get the GraphQL typename for a Pydantic model.
funcwandb._pydantic.utils.to_json(v:Any) -> str
Quickly serialize a (possibly Pydantic) object to a JSON string.
funcwandb._strutils.b64decode_ascii(s:str) -> str
Returns the decoded base64 string interpreted as ASCII.
funcwandb._strutils.b64encode_ascii(s:str) -> str
Returns the base64 encoding of the string's ASCII bytes.
funcwandb._strutils.ensureprefix(s:str, prefix:str) -> str
Ensures the string has the given prefix prepended.
funcwandb._strutils.nameof(obj:Any, full:bool=True) -> str
Internal convenience helper that returns the object's `__name__` or `__qualname__`.
classwandb.analytics.opentelemetry.opentelemetry_proxy.TelemetryRecorder
Records OpenTelemetry events (metrics and logs).
methodwandb.analytics.opentelemetry.opentelemetry_proxy.TelemetryRecorder.exception(message:str, exc:Exception) -> None
Record an exception as both a counter metric and an error log.
methodwandb.analytics.opentelemetry.opentelemetry_proxy.TelemetryRecorder.reraise(exc:Exception) -> Never
Log the exception to telemetry, then re-raise it.
funcwandb.analytics.sentry.get_sentry() -> Sentry
Return the Sentry singleton for the current process (fork-aware).
methodwandb.apis.attrs.Attrs.display(height=420, hidden=False) -> bool
Display this object in jupyter.
classwandb.apis.internal.Api
Internal proxy to the official internal API.
classwandb.apis.paginator.Paginator
An iterator for paginated objects from GraphQL requests.
methodwandb.apis.paginator.Paginator.cursor() -> str | None
The start cursor to use for the next fetched page.
methodwandb.apis.paginator.Paginator.more() -> bool
Whether there are more pages to be fetched.
methodwandb.apis.paginator.Paginator.update_variables() -> None
Update the query variables for the next page fetch.
classwandb.apis.paginator.RelayPaginator
A Paginator for GQL relay-style nodes parsed via Pydantic.
classwandb.apis.paginator.SizedPaginator
A Paginator for objects with a known total count.
classwandb.apis.public.api.Api
Used for querying the W&B server.
methodwandb.apis.public.api.Api.artifact(name:str, type:str | None=None)
Returns a single artifact.
methodwandb.apis.public.api.Api.artifact_collection(type_name:str, name:str) -> ArtifactCollection
Returns a single artifact collection by type.
methodwandb.apis.public.api.Api.artifact_type(type_name:str, project:str | None=None) -> ArtifactType
Returns the matching `ArtifactType`.
methodwandb.apis.public.api.Api.artifact_types(project:str | None=None, start:str | None=None) -> ArtifactTypes
Returns a collection of matching artifact types.
methodwandb.apis.public.api.Api.artifact_versions(type_name, name, per_page=50)
Deprecated.
methodwandb.apis.public.api.Api.artifacts(type_name:str, name:str, order:str | None=None, per_page:int=50, tags:list[str] | None=None, start:str | None=None) -> Artifacts
Return an `Artifacts` collection.
methodwandb.apis.public.api.Api.automation(name:str, *entity:str | None=None) -> Automation
Returns the only Automation matching the parameters.
methodwandb.apis.public.api.Api.create_automation(obj:NewAutomation, *fetch_existing:bool=False, **kwargs:Unpack[WriteAutomationsKwargs]) -> Automation
Create a new Automation.
methodwandb.apis.public.api.Api.create_project(name:str, entity:str) -> None
Create a new project.
methodwandb.apis.public.api.Api.create_registry(name:str, visibility:Literal['organization', 'restricted'], organization:str | None=None, description:str | None=None, artifact_types:list[str] | None=None) -> Registry
Create a new registry.
methodwandb.apis.public.api.Api.create_run(*run_id:str | None=None, *project:str | None=None, *entity:str | None=None) -> public.Run
Create a new run.
methodwandb.apis.public.api.Api.create_team(team:str, admin_username:str | None=None) -> Team
Create a new team.
methodwandb.apis.public.api.Api.create_user(email:str, admin:bool | None=False) -> User
Create a new user.
methodwandb.apis.public.api.Api.default_entity() -> str | None
Returns the default W&B entity.
methodwandb.apis.public.api.Api.delete_automation(obj:Automation | str) -> Literal[True]
Delete an automation.
methodwandb.apis.public.api.Api.flush()
Flush the local cache.
methodwandb.apis.public.api.Api.from_path(path:str)
Return a run, sweep, project or report from a path.
methodwandb.apis.public.api.Api.integrations(entity:str | None=None, *per_page:int=50, *start:str | None=None) -> Iterator[Integration]
Return an iterator of all integrations for an entity.
methodwandb.apis.public.api.Api.job(name:str | None, path:str | None=None) -> public.Job
Return a `Job` object.
methodwandb.apis.public.api.Api.list_jobs(entity:str, project:str) -> list[dict[str, Any]]
Return a list of jobs, if any, for the given entity and project.
methodwandb.apis.public.api.Api.organization(name:str | None=None) -> Organization
Return the matching `Organization`.
methodwandb.apis.public.api.Api.project(name:str, entity:str | None=None) -> public.Project
Return the `Project` with the given name (and entity, if given).
methodwandb.apis.public.api.Api.projects(entity:str | None=None, per_page:int=200) -> public.Projects
Get projects for a given entity.
methodwandb.apis.public.api.Api.registry(name:str, organization:str | None=None) -> Registry
Return a registry given a registry name.
methodwandb.apis.public.api.Api.reports(path:str='', name:str | None=None, per_page:int=50) -> public.Reports
Get reports for a given project path.
methodwandb.apis.public.api.Api.run_queue(entity:str, name:str)
Return the named `RunQueue` for entity.
methodwandb.apis.public.api.Api.team(team:str) -> Team
Return the matching `Team` with the given name.
methodwandb.apis.public.api.Api.update_automation(obj:Automation, *create_missing:bool=False, **kwargs:Unpack[WriteAutomationsKwargs]) -> Automation
Update an existing automation.
methodwandb.apis.public.api.Api.user(username_or_email:str) -> User | None
Return a user from a username or email address.
methodwandb.apis.public.api.Api.user_agent() -> str
Returns W&B public user agent.
methodwandb.apis.public.api.Api.users(username_or_email:str) -> list[User]
Return all users from a partial username or email address query.
methodwandb.apis.public.api.Api.viewer() -> User
Returns the viewer object.
methodwandb.apis.public.artifacts.ArtifactCollection.artifacts(per_page:int=50, start:str | None=None) -> Artifacts
Get all artifacts in the collection.
methodwandb.apis.public.artifacts.ArtifactCollection.change_type(new_type:str) -> None
Deprecated, change type directly with `save` instead.
methodwandb.apis.public.artifacts.ArtifactCollection.created_at() -> str
The creation date of the artifact collection.
methodwandb.apis.public.artifacts.ArtifactCollection.delete() -> None
Delete the entire artifact collection.
methodwandb.apis.public.artifacts.ArtifactCollection.description() -> str | None
A description of the artifact collection.
methodwandb.apis.public.artifacts.ArtifactCollection.entity() -> str
The entity (user or team) that owns the project.
methodwandb.apis.public.artifacts.ArtifactCollection.id() -> str
The unique identifier of the artifact collection.
methodwandb.apis.public.artifacts.ArtifactCollection.is_sequence() -> bool
Return whether the artifact collection is a sequence.
methodwandb.apis.public.artifacts.ArtifactCollection.name() -> str
The name of the artifact collection.
methodwandb.apis.public.artifacts.ArtifactCollection.project() -> str
The project that contains the artifact collection.
methodwandb.apis.public.artifacts.ArtifactCollection.save() -> None
Persist any changes made to the artifact collection.
methodwandb.apis.public.artifacts.ArtifactCollection.tags() -> list[str]
The tags associated with the artifact collection.
methodwandb.apis.public.artifacts.ArtifactCollection.type()
Returns the type of the artifact collection.
classwandb.apis.public.artifacts.ArtifactCollections
Artifact collections of a specific type in a project.
classwandb.apis.public.artifacts.ArtifactFiles
A paginator for files in an artifact.
methodwandb.apis.public.artifacts.ArtifactFiles.path() -> list[str]
Returns the path of the artifact.
methodwandb.apis.public.artifacts.ArtifactType.collection(name:str) -> ArtifactCollection
Get a specific artifact collection by name.
methodwandb.apis.public.artifacts.ArtifactType.id() -> str
The unique identifier of the artifact type.
methodwandb.apis.public.artifacts.ArtifactType.load() -> ArtifactTypeFragment
Load the artifact type attributes from W&B.
methodwandb.apis.public.artifacts.ArtifactType.name() -> str
The name of the artifact type.
classwandb.apis.public.artifacts.ProjectArtifactCollections
Artifact collections in a project.
classwandb.apis.public.files.File
File saved to W&B.
methodwandb.apis.public.files.File.delete() -> None
Delete the file from the W&B server.
methodwandb.apis.public.files.File.path_uri() -> str
Returns the URI path to the file in the storage bucket.
methodwandb.apis.public.files.File.size() -> int
Returns the size of the file in bytes.
classwandb.apis.public.files.Files
A lazy iterator over a collection of `File` objects.
methodwandb.apis.public.files.Files.convert_objects() -> list[File]
Converts GraphQL edges to File objects.
methodwandb.apis.public.files.Files.cursor() -> str | None
Returns the cursor position for pagination of file results.
methodwandb.apis.public.files.Files.more() -> bool
Returns whether there are more files to fetch.
methodwandb.apis.public.files.Files.update_variables() -> None
Updates the GraphQL query variables for pagination.
classwandb.apis.public.history.HistoryScan
Iterator for scanning complete run history.
methodwandb.apis.public.history.HistoryScan.max_step() -> int
The highest step that can be yielded by this scan.
classwandb.apis.public.integrations.Integrations
A lazy iterator of `Integration` objects.
classwandb.apis.public.integrations.SlackIntegrations
A lazy iterator of `SlackIntegration` objects.
classwandb.apis.public.integrations.WebhookIntegrations
A lazy iterator of `WebhookIntegration` objects.
methodwandb.apis.public.jobs.Job.name() -> str
The name of the job.
methodwandb.apis.public.jobs.Job.set_entrypoint(entrypoint:list[str]) -> None
Set the entrypoint for the job.
classwandb.apis.public.jobs.QueuedRun
A single queued run associated with an entity and project.
methodwandb.apis.public.jobs.QueuedRun.delete(delete_artifacts:bool=False) -> None
Delete the given queued run from the wandb backend.
methodwandb.apis.public.jobs.QueuedRun.entity() -> str
The entity associated with the queued run.
methodwandb.apis.public.jobs.QueuedRun.id() -> str
The id of the queued run.
methodwandb.apis.public.jobs.QueuedRun.project() -> str
The project associated with the queued run.
methodwandb.apis.public.jobs.QueuedRun.queue_name() -> str
The name of the queue.
methodwandb.apis.public.jobs.QueuedRun.state() -> str
The state of the queued run.
classwandb.apis.public.jobs.RunQueue
Class that represents a run queue in W&B.
methodwandb.apis.public.jobs.RunQueue.access() -> RunQueueAccessType
The access level of the queue.
methodwandb.apis.public.jobs.RunQueue.create(name:str, resource:RunQueueResourceType, entity:str | None=None, prioritization_mode:RunQueuePrioritizationMode | None=None, config:dict | None=None, template_variables:dict | None=None) -> RunQueue
Create a RunQueue.
methodwandb.apis.public.jobs.RunQueue.default_resource_config() -> dict[str, Any]
The default configuration for resources.
methodwandb.apis.public.jobs.RunQueue.delete() -> None
Delete the run queue from the wandb backend.
methodwandb.apis.public.jobs.RunQueue.entity() -> str
The entity that owns the queue.
methodwandb.apis.public.jobs.RunQueue.external_links() -> dict[str, str]
External resource links for the queue.
methodwandb.apis.public.jobs.RunQueue.id() -> str
The id of the queue.
methodwandb.apis.public.jobs.RunQueue.items() -> list[QueuedRun]
Up to the first 100 queued runs.
methodwandb.apis.public.jobs.RunQueue.name() -> str
The name of the queue.
methodwandb.apis.public.jobs.RunQueue.prioritization_mode() -> RunQueuePrioritizationMode
The prioritization mode of the queue.
methodwandb.apis.public.jobs.RunQueue.template_variables() -> dict[str, Any]
Variables for resource templates.
methodwandb.apis.public.jobs.RunQueue.type() -> RunQueueResourceType
The resource type for execution.
classwandb.apis.public.organizations.Organization
A read-only representation of a W&B organization.
classwandb.apis.public.projects.Project
A project is a namespace for runs.
methodwandb.apis.public.projects.Project.artifacts_types(per_page:int=50) -> public.ArtifactTypes
Returns all artifact types associated with this project.
methodwandb.apis.public.projects.Project.owner() -> public.User
Returns the project owner as a User object.
methodwandb.apis.public.projects.Project.path() -> list[str]
Returns the path of the project.
methodwandb.apis.public.projects.Project.to_html(height:int=420, hidden:bool=False) -> str
Generate HTML containing an iframe displaying this project.
methodwandb.apis.public.projects.Project.url() -> str
Returns the URL of the project.
classwandb.apis.public.projects.Projects
An lazy iterator of `Project` objects.
methodwandb.apis.public.projects.Projects.length() -> None
Returns the total number of projects.
classwandb.apis.public.query_generator.QueryGenerator
QueryGenerator is a helper object to write filters for runs.
methodwandb.apis.public.query_generator.QueryGenerator.format_order_key(key:str)
Format a key for sorting.
classwandb.apis.public.registries._members.MemberKind
Identifies what kind of object a registry member is.
classwandb.apis.public.registries._members.MemberRole
Identifies the role of a member.
methodwandb.apis.public.registries._utils.Visibility.from_gql(value:str) -> Visibility
Convert a GraphQL `visibility` value to a Visibility enum.
methodwandb.apis.public.registries._utils.Visibility.from_python(name:str) -> Visibility
Convert a visibility string to a `Visibility` enum.
funcwandb.apis.public.registries._utils.fetch_org_entity_from_organization(service_api:ServiceApi, organization:str) -> str
Fetch the org entity from the organization.
funcwandb.apis.public.registries._utils.prepare_artifact_types_input(artifact_types:Collection[str] | None) -> list[dict[str, str]] | None
Format the artifact types for the GQL input.
classwandb.apis.public.registries.registries_search.Registries
A lazy iterator of `Registry` objects.
classwandb.apis.public.registries.registries_search.Versions
An lazy iterator of `Artifact` objects in a Registry.
classwandb.apis.public.registries.registry.Registry
A single registry in the Registry.
methodwandb.apis.public.registries.registry.Registry.add_members(*members:User | UserMember | Team | TeamMember | str) -> Self
Adds users or teams to this registry.
methodwandb.apis.public.registries.registry.Registry.create(api:Api, organization:str, name:str, visibility:Literal['organization', 'restricted'], description:str | None=None, artifact_types:list[str] | None=None) -> Self
Create a new registry.
methodwandb.apis.public.registries.registry.Registry.created_at() -> str
Timestamp of when the registry was created.
methodwandb.apis.public.registries.registry.Registry.delete() -> None
Delete the registry.
methodwandb.apis.public.registries.registry.Registry.description() -> str | None
Description of the registry.
methodwandb.apis.public.registries.registry.Registry.entity() -> str
Organization entity of the registry.
methodwandb.apis.public.registries.registry.Registry.id() -> str
The unique ID for this registry.
methodwandb.apis.public.registries.registry.Registry.load() -> None
Load registry attributes from the backend.
methodwandb.apis.public.registries.registry.Registry.organization() -> str
Organization name of the registry.
methodwandb.apis.public.registries.registry.Registry.remove_members(*members:User | UserMember | Team | TeamMember | str) -> Self
Removes users or teams from this registry.
methodwandb.apis.public.registries.registry.Registry.save() -> None
Save registry attributes to the backend.
methodwandb.apis.public.registries.registry.Registry.updated_at() -> str | None
Timestamp of when the registry was last updated.
methodwandb.apis.public.registries.registry.Registry.visibility() -> Literal['organization', 'restricted']
Visibility of the registry.
classwandb.apis.public.reports.BetaReport
BetaReport is a class associated with reports created in W&B.
methodwandb.apis.public.reports.BetaReport.runs(section:dict[str, Any], per_page:int=50, only_selected:bool=True) -> public.Runs
Get runs associated with a section of the report.
methodwandb.apis.public.reports.BetaReport.to_html(height:int=1024, hidden:bool=False) -> str
Generate HTML containing an iframe displaying this report.
classwandb.apis.public.reports.Reports
Reports is a lazy iterator of `BetaReport` objects.
methodwandb.apis.public.reports.Reports.convert_objects() -> list[BetaReport]
Converts GraphQL edges to File objects.
methodwandb.apis.public.reports.Reports.more() -> bool
Returns whether there are more files to fetch.
methodwandb.apis.public.reports.Reports.update_variables() -> None
Updates the GraphQL query variables for pagination.
classwandb.apis.public.runhistory.downloads.DownloadHistoryResult
Result of downloading a run's history exports.
classwandb.apis.public.runhistory.downloads.IncompleteRunHistoryError
Raised when run history has incomplete history.
classwandb.apis.public.runs.AgentRuns
A lazy iterator of `Run` objects for a single sweep agent.
classwandb.apis.public.runs.Run
A single run associated with an entity and project.
methodwandb.apis.public.runs.Run.config() -> dict[str, Any]
Get run config.
methodwandb.apis.public.runs.Run.create(api:public.Api, run_id:str | None=None, project:str | None=None, entity:str | None=None, state:Literal['running', 'pending']='running') -> Run
Create a run for the given project.
methodwandb.apis.public.runs.Run.delete(delete_artifacts:bool=False) -> None
Delete the given run from the wandb backend.
methodwandb.apis.public.runs.Run.entity() -> str
The entity associated with the run.
methodwandb.apis.public.runs.Run.file(name:str) -> public.File
Return the path of a file with a given name in the artifact.
methodwandb.apis.public.runs.Run.id() -> str
The unique identifier for the run.
methodwandb.apis.public.runs.Run.json_config() -> str
Return the run config as a JSON string.
methodwandb.apis.public.runs.Run.lastHistoryStep() -> int
Returns the last step logged in the run's history.
methodwandb.apis.public.runs.Run.load(force:bool=False) -> dict[str, Any]
Load run data using appropriate fragment based on lazy mode.
methodwandb.apis.public.runs.Run.log_artifact(artifact:wandb.Artifact, aliases:Collection[str] | None=None, tags:Collection[str] | None=None) -> wandb.Artifact
Declare an artifact as output of a run.
methodwandb.apis.public.runs.Run.logged_artifacts(per_page:int=100) -> public.RunArtifacts
Fetches all artifacts logged by this run.
methodwandb.apis.public.runs.Run.metadata() -> dict[str, Any] | None
Metadata about the run from wandb-metadata.json.
methodwandb.apis.public.runs.Run.name() -> str | None
The name of the run.
methodwandb.apis.public.runs.Run.path() -> list[str]
The path of the run.
methodwandb.apis.public.runs.Run.rawconfig() -> dict[str, Any]
Get raw run config including internal keys.
methodwandb.apis.public.runs.Run.save() -> None
Persist changes to the run object to the W&B backend.
methodwandb.apis.public.runs.Run.state() -> str
The state of the run.
methodwandb.apis.public.runs.Run.stop() -> None
Request that this run stop gracefully.
methodwandb.apis.public.runs.Run.storage_id() -> str
The unique storage identifier for the run.
methodwandb.apis.public.runs.Run.summary() -> HTTPSummary
Get run summary metrics.
methodwandb.apis.public.runs.Run.summary_metrics() -> dict[str, Any]
Get run summary metrics.
methodwandb.apis.public.runs.Run.sweep() -> public.Sweep | None
The sweep associated with this run.
methodwandb.apis.public.runs.Run.sweep_name() -> str | None
Get sweep name.
methodwandb.apis.public.runs.Run.system_metrics() -> dict[str, Any]
Get run system metrics.
methodwandb.apis.public.runs.Run.to_html(height:int=420, hidden:bool=False) -> str
Generate HTML containing an iframe displaying this run.
methodwandb.apis.public.runs.Run.update() -> None
Persist changes to the run object to the wandb backend.
methodwandb.apis.public.runs.Run.update_state(state:str) -> bool
Update the state of a run.
methodwandb.apis.public.runs.Run.upload_file(path:str, root:str='.') -> public.File
Upload a local file to W&B, associating it with this run.
methodwandb.apis.public.runs.Run.url() -> str
The URL of the run.
methodwandb.apis.public.runs.Run.use_artifact(artifact:wandb.Artifact, use_as:str | None=None) -> wandb.Artifact
Declare an artifact as an input to a run.
methodwandb.apis.public.runs.Run.used_artifacts(per_page:int=100) -> public.RunArtifacts
Fetches artifacts explicitly used by this run.
methodwandb.apis.public.runs.Run.username() -> str
This API is deprecated.
methodwandb.apis.public.runs.Run.wait_until_finished() -> None
Check the state of the run until it is finished.
classwandb.apis.public.runs.RunNotFoundError
Raised when a run's data is not able to be loaded.
methodwandb.apis.public.runs.Runs.convert_objects() -> list[Run]
Converts GraphQL edges to Runs objects.
methodwandb.apis.public.runs.Runs.more() -> bool
Returns whether there are more runs to fetch.
methodwandb.apis.public.runs.Runs.upgrade_to_full() -> None
Upgrade this Runs collection from lazy to full mode.
classwandb.apis.public.summary.Summary
Store summary metrics (eg.
classwandb.apis.public.summary.SummarySubDict
Nested dict-like object.
methodwandb.apis.public.sweeps.Agent.runs(per_page:int=50) -> AgentRuns
Return a paginated collection of runs executed by this agent.
classwandb.apis.public.sweeps.Sweep
The set of runs associated with the sweep.
methodwandb.apis.public.sweeps.Sweep.agent(agent_id:str) -> Agent
Query an agent by ID for this sweep.
methodwandb.apis.public.sweeps.Sweep.agents() -> list[Agent]
Query the list of all agents for this sweep.
methodwandb.apis.public.sweeps.Sweep.enqueue_run(config:dict, display_name:str | None=None) -> str
Enqueue a run for the sweep.
methodwandb.apis.public.sweeps.Sweep.entity() -> str
The entity associated with the sweep.
methodwandb.apis.public.sweeps.Sweep.name()
The name of the sweep.
methodwandb.apis.public.sweeps.Sweep.order()
Return the order key for the sweep.
methodwandb.apis.public.sweeps.Sweep.path()
Returns the path of the project.
methodwandb.apis.public.sweeps.Sweep.to_html(height:int=420, hidden:bool=False) -> str
Generate HTML containing an iframe displaying this sweep.
methodwandb.apis.public.sweeps.Sweep.url()
The URL of the sweep.
methodwandb.apis.public.sweeps.Sweep.username() -> str
Deprecated.
classwandb.apis.public.sweeps.Sweeps
A lazy iterator over a collection of `Sweep` objects.
methodwandb.apis.public.sweeps.Sweeps.cursor() -> str | None
Returns the cursor for the next page of sweeps.
methodwandb.apis.public.sweeps.Sweeps.more() -> bool
Returns whether there are more sweeps to fetch.
classwandb.apis.public.teams.Member
A member of a team.
methodwandb.apis.public.teams.Member.delete()
Remove a member from a team.
classwandb.apis.public.teams.Team
A class that represents a W&B team.
methodwandb.apis.public.teams.Team.create(api:Api, team:str, admin_username:str | None=None) -> Team
Create a new team.
methodwandb.apis.public.teams.Team.create_service_account(description:str) -> Member | None
Create a service account for the team.
methodwandb.apis.public.teams.Team.invite(username_or_email:str, admin:bool=False) -> bool
Invite a user to a team.
methodwandb.apis.public.teams.Team.load(force:bool=False) -> dict[str, Any]
Return members that belong to a team.
classwandb.apis.public.users.User
A user on a W&B instance.
methodwandb.apis.public.users.User.api_keys() -> list[str]
Names of the user's API keys.
methodwandb.apis.public.users.User.create(api:Api, email:str, admin:bool | None=False) -> Self
Create a new user.
methodwandb.apis.public.users.User.delete_api_key(api_key:str) -> bool
Delete a user's API key.
methodwandb.apis.public.users.User.generate_api_key(description:str | None=None) -> str | None
Generate a new API key.
methodwandb.apis.public.users.User.teams() -> list[str]
Names of the user's teams.
methodwandb.apis.public.users.User.user_api() -> Api | None
A `wandb.Api` instance using the user's credentials.
funcwandb.apis.public.utils.parse_org_from_registry_path(path:str, path_type:PathType) -> str
Parse the org from a registry path.
funcwandb.apis.public.utils.parse_s3_url_to_s3_uri(url) -> str
Convert an S3 HTTP(S) URL to an S3 URI.
classwandb.automations._run_metric_filters.Agg
Supported run metric aggregation operations.
classwandb.automations._run_metric_filters.ChangeDir
Describes the direction of the metric change.
classwandb.automations._run_state_filters.StateOperand
Descriptor type, returned on accessing `RunEvent.state`.
methodwandb.automations._run_state_filters.StateOperand.eq(state:str | ReportedRunState) -> StateFilter
Returns a filter that watches for `run_state == state`.
methodwandb.automations._run_state_filters.StateOperand.in_(states:Iterable[str | ReportedRunState]) -> StateFilter
Returns a filter that watches for `run_state in states`.
classwandb.automations._utils.ActionSpecInput
Input action spec for saving an automation.
classwandb.automations._validators.LenientStrEnum
A string enum allowing for case-insensitive lookups by value.
funcwandb.automations._validators.ensure_json(v:Any) -> Any
In case the incoming value isn't serialized JSON, reserialize it.
funcwandb.automations._validators.parse_input_action(v:Any) -> Any
If necessary (and possible), convert the object to an input action.
funcwandb.automations._validators.parse_saved_action(v:Any) -> Any
If necessary (and possible), convert the object to a saved action.
funcwandb.automations._validators.wrap_mutation_event_filter(f:MongoLikeFilter) -> MongoLikeFilter
Wrap filters as `{"$or": [{"$and": [<original_filter>]}]}`.
classwandb.automations.actions.ActionType
The type of action triggered by an automation.
classwandb.automations.actions.DoNothing
Defines an automation action that intentionally does nothing.
classwandb.automations.actions.SendWebhook
Defines an automation action that sends a webhook request.
classwandb.automations.automations.NewAutomation
A new automation to be created.
classwandb.automations.events.EventType
The type of event that triggers an automation.
classwandb.automations.events.OnAddArtifactAlias
A new alias is assigned to an artifact.
classwandb.automations.events.OnAddArtifactTag
A new tag is assigned to an artifact version.
classwandb.automations.events.OnAddCollectionTag
A new tag is assigned to an artifact collection.
classwandb.automations.events.OnCreateArtifact
A new artifact is created.
classwandb.automations.events.OnLinkArtifact
A new artifact is linked to a collection.
classwandb.automations.events.OnRemoveArtifactTag
A tag is removed from an artifact version.
classwandb.automations.events.OnRemoveCollectionTag
A tag is removed from an artifact collection.
classwandb.automations.events.OnRunMetric
A run metric satisfies a user-defined condition.
classwandb.automations.events.OnRunState
A run state changes.
classwandb.automations.events.OnUnlinkArtifact
An artifact version is unlinked from a collection.
methodwandb.automations.events.RunEvent.metric(name:str) -> MetricVal
Define a metric filter condition.
classwandb.automations.events.SavedEvent
A triggering event from a saved automation.
classwandb.automations.scopes.OrgScope
A scope defined by an org `Entity`.
classwandb.automations.scopes.ProjectScope
A scope defined by a `Project`.
classwandb.automations.scopes.ScopeType
The kind of scope that triggers an automation.
classwandb.automations.scopes.TeamScope
A scope defined by a team `Entity`.
funcwandb.cli.beta.beta(ctx:click.Context) -> None
Beta versions of wandb CLI commands.
funcwandb.cli.beta.start(idle_timeout:str) -> None
Start a detached wandb-core service.
funcwandb.cli.beta.stop() -> None
Stop a detached wandb-core service.
funcwandb.cli.beta_core.start(*idle_timeout:str) -> None
Start a detached wandb-core service.
funcwandb.cli.beta_core.stop(*exit_code:int=0) -> None
Stop a detached wandb-core service addressed by WANDB_SERVICE.
classwandb.cli.beta_sandbox.SandboxGroup
Click group for sandbox commands.
funcwandb.cli.beta_sandbox.exec_in_sandbox(sandbox_id:str, command_args:tuple[str, ...], cwd:str | None, timeout_seconds:float | None) -> None
Execute a command in a sandbox.
funcwandb.cli.beta_sandbox.list_sandboxes(status:str | None, include_stopped:bool, tags:tuple[str, ...], output_format:str) -> None
List sandboxes.
funcwandb.cli.beta_sandbox.logs(sandbox_id:str, follow:bool, tail_lines:int | None, since_time:datetime | None, timestamps:bool) -> None
Stream logs from a sandbox's main process.
funcwandb.cli.beta_sandbox.sandbox() -> None
Manage W&B sandboxes.
funcwandb.cli.beta_sandbox.shell(sandbox_id:str, cmd:str) -> None
Open an interactive shell in a sandbox.
funcwandb.cli.clean.clean(ctx:click.Context, min_hours:int, include_unsynced:bool, force:bool) -> None
Remove synced run data.
funcwandb.cli.cli.agent(ctx, project, entity, count, forward_signals, term_timeout, sweep_id)
Start a sweep agent.
funcwandb.cli.cli.cleanup(target_size, remove_temp)
Reduce the local artifact cache size.
funcwandb.cli.cli.disabled(service)
Disable W&B functionality.
funcwandb.cli.cli.get(path, root, type)
Download an artifact from W&B by its path.
funcwandb.cli.cli.ls(path, type)
List all artifacts in a W&B project.
funcwandb.cli.cli.online()
Re-enable cloud syncing for W&B runs.
funcwandb.cli.cli.projects(entity, display=True)
List projects for the current entity.
funcwandb.cli.cli.pull(run, project, entity)
Download files from a W&B run.
funcwandb.cli.cli.put(path, name, description, type, alias, run_id, resume, skip_cache, policy)
Upload an artifact to W&B.
funcwandb.cli.cli.stop()
Stop a running local W&B server.
classwandb.cli.leet.DefaultCommandGroup
A click Group that falls through to a default command.
classwandb.cli.leet.LaunchConfig
Configuration for launching LEET.
classwandb.cli.leet.LocalLaunchConfig
Configuration for launching LEET.
classwandb.cli.leet.RemoteLaunchConfig
Configuration for launching LEET against a remote run.
funcwandb.cli.leet.config() -> None
Edit LEET configuration.
funcwandb.cli.leet.launch(path:str | None, pprof:str) -> Never
Launch the LEET TUI.
funcwandb.cli.leet.launch_config() -> Never
Launch the LEET configuration editor.
funcwandb.cli.leet.launch_symon(pprof:str='', interval:str='') -> Never
Launch the standalone system monitor.
funcwandb.cli.leet.leet() -> None
W&B LEET: the Lightweight Experiment Exploration Tool.
funcwandb.cli.leet.run(path:str | None=None, pprof:str='') -> None
Launch the LEET TUI.
funcwandb.cli.leet.symon(pprof:str='', interval:str='') -> None
Launch the standalone system monitor.
classwandb.docker.DockerError
Raised when attempting to execute a docker command.
funcwandb.docker.get_image_uid(image_name:str) -> int
Retrieve the image default uid through brute force.
funcwandb.docker.image_id(image_name:str) -> str | None
Retrieve the image id from the local docker daemon or remote registry.
funcwandb.docker.image_id_from_registry(image_name:str) -> str | None
Query the image manifest to get its full ID including the digest.
funcwandb.docker.is_buildx_installed() -> bool
Return `True` if docker buildx is installed and working.
funcwandb.docker.is_docker_installed() -> bool
Return `True` if docker is installed and working, else `False`.
funcwandb.docker.login(username:str, password:str, registry:str) -> str | None
Login to a registry.
classwandb.docker.names.InvalidRepositoryError
The given string is not a valid repository name.
funcwandb.docker.push(image:str, tag:str) -> str | None
Push an image to a remote registry.
funcwandb.docker.shell(cmd:list[str]) -> str | None
Simple wrapper for calling docker,.
funcwandb.docker.tag(image_name:str, tag:str) -> str | None
Tag an image.
funcwandb.env.strtobool(val:str) -> bool
Convert a string representation of truth to true or false.
classwandb.errors.errors.AuthenticationError
Raised when authentication fails.
classwandb.errors.errors.CommError
Error communicating with W&B servers.
classwandb.errors.errors.Error
Base W&B Error.
classwandb.errors.errors.UnsupportedError
Raised when trying to use a feature that is not supported.
classwandb.errors.errors.UsageError
Raised when an invalid usage of the SDK API is detected.
classwandb.errors.errors.WandbCoreNotAvailableError
Raised when wandb core is not available.
classwandb.errors.links.Registry
A collection of URLs that can be associated with a name.
methodwandb.errors.links.Registry.description(name:str) -> str
Get the description associated with the given name.
methodwandb.errors.links.Registry.url(name:str) -> str
Get the URL associated with the given name.
classwandb.errors.term.DynamicBlock
A handle to a changeable text area in the terminal.
methodwandb.errors.term.DynamicBlock.set_text(text:str, prefix:bool=True) -> None
Replace the text in this block.
classwandb.errors.term.SupportsLeveledLogging
Portion of the standard logging.Logger used in this module.
funcwandb.errors.term.can_use_terminput() -> bool
Returns True if terminput won't raise a NotATerminalError.
funcwandb.errors.term.confirm(prompt:str) -> bool
Prompt the user with a yes/no question.
funcwandb.errors.term.termerror(string:str, newline:bool=True, repeat:bool=True, prefix:bool=True) -> None
Log an error to stderr.
funcwandb.errors.term.terminput(prompt:str, *timeout:float | None=None, *hide:bool=False) -> str
Prompt the user for input.
funcwandb.errors.term.termlog(string:str='', newline:bool=True, repeat:bool=True, prefix:bool=True) -> None
Log an informational message to stderr.
funcwandb.errors.term.termsetup(settings:wandb.Settings, logger:SupportsLeveledLogging | None) -> None
Configure the global logging functions.
funcwandb.errors.term.termwarn(string:str, newline:bool=True, repeat:bool=True, prefix:bool=True) -> None
Log a warning to stderr.
classwandb.errors.util.ProtobufErrorHandler
Converts protobuf errors to exceptions and vice versa.
methodwandb.errors.util.ProtobufErrorHandler.from_exception(exc:Error) -> pb.ErrorInfo
Convert an wandb error to a protobuf error message.
methodwandb.errors.util.ProtobufErrorHandler.to_exception(error:pb.ErrorInfo) -> Error | None
Convert a protobuf error to an exception.
classwandb.errors.warnings.WandbWarning
Base W&B Warning.
classwandb.filesync.dir_watcher.PolicyEnd
This policy only updates at the end of the run.
classwandb.filesync.dir_watcher.PolicyLive
Event handler that uploads respecting throttling.
classwandb.filesync.dir_watcher.PolicyNow
This policy only uploads files now.
classwandb.filesync.step_prepare.StepPrepare
A thread that batches requests to our file prepare API.
methodwandb.integration.dspy.dspy.WandbDSPyCallback.on_evaluate_end(call_id:str, outputs:Any | None, exception:Exception | None=None) -> None
Handle end of a DSPy evaluation call.
methodwandb.integration.dspy.dspy.WandbDSPyCallback.on_evaluate_start(call_id:str, instance:Any, inputs:dict[str, Any]) -> None
Handle start of a DSPy evaluation call.
classwandb.integration.fastai.WandbCallback
Callback for saving model topology, losses & metrics.
methodwandb.integration.fastai.WandbCallback.on_train_begin(**kwargs:Any) -> None
Call watch method to log model topology, gradients & weights.
methodwandb.integration.fastai.WandbCallback.on_train_end(**kwargs:Any) -> None
Load the best model.
funcwandb.integration.gym.monitor()
Monitor a gym environment.
classwandb.integration.keras.callbacks.metrics_logger.WandbMetricsLogger
Logger that sends system metrics to W&B.
methodwandb.integration.keras.callbacks.metrics_logger.WandbMetricsLogger.on_epoch_end(epoch:int, logs:dict[str, Any] | None=None) -> None
Called at the end of an epoch.
funcwandb.integration.kfp._patch_utils.unpatch(module_name:str) -> None
Restore original functions previously replaced by `patch`.
funcwandb.integration.kfp.kfp_patch.patch_kfp() -> None
Apply KFP monkey-patches for the detected KFP version.
funcwandb.integration.kfp.kfp_patch.unpatch_kfp() -> None
Undo all KFP monkey-patches applied by `patch_kfp`.
funcwandb.integration.kfp.wandb_log_v2.wandb_log(func:Callable | None=None) -> Callable
Wrap a KFP v2 component function and log to W&B.
funcwandb.integration.lightgbm.wandb_callback(log_params:bool=True, define_metric:bool=True) -> Callable
Automatically integrates LightGBM with wandb.
funcwandb.integration.metaflow.data_pandas.is_dataframe(data:Any) -> TypeIs[pd.DataFrame]
Returns whether the data is a Pandas DataFrame.
funcwandb.integration.metaflow.data_pandas.track_dataframe(name:str, data:pd.DataFrame, run:wandb.Run | None, testing:bool=False) -> str | None
Log a DataFrame output as an artifact.
funcwandb.integration.metaflow.data_pandas.use_dataframe(name:str, run:wandb.Run | None, testing:bool=False) -> str | None
Log a dependency on a DataFrame input.
funcwandb.integration.metaflow.data_pytorch.is_nn_module(data:Any) -> TypeIs[nn.Module]
Returns whether the data is a PyTorch nn.Module.
funcwandb.integration.metaflow.data_pytorch.track_nn_module(name:str, data:nn.Module, run:wandb.Run | None, testing:bool=False) -> str | None
Log a PyTorch model output as an artifact.
funcwandb.integration.metaflow.data_pytorch.use_nn_module(name:str, run:wandb.Run | None, testing:bool=False) -> str | None
Log a dependency on a PyTorch model input.
funcwandb.integration.metaflow.data_sklearn.is_estimator(data:Any) -> TypeIs[BaseEstimator]
Returns whether the data is an sklearn BaseEstimator.
funcwandb.integration.metaflow.data_sklearn.track_estimator(name:str, data:BaseEstimator, run:wandb.Run | None, testing:bool=False) -> str | None
Log an sklearn estimator output as an artifact.
funcwandb.integration.metaflow.data_sklearn.use_estimator(name:str, run:wandb.Run | None, testing:bool=False) -> str | None
Log a dependency on an sklearn estimator.
classwandb.integration.metaflow.errors.MissingDependencyError
An optional dependency is missing.
methodwandb.integration.metaflow.errors.MissingDependencyError.warn() -> None
Print a warning for the problem.
funcwandb.integration.prodigy.prodigy.create_table(data)
Create a W&B Table.
funcwandb.integration.prodigy.prodigy.named_entity(docs)
Create a named entity visualization.
classwandb.integration.sacred.WandbObserver
Log sacred experiment data to W&B.
methodwandb.integration.sacred.WandbObserver.resource_event(filename)
TODO: Maintain resources list.
funcwandb.integration.sagemaker.config.is_using_sagemaker() -> bool
Returns whether we're in a SageMaker environment.
funcwandb.integration.sagemaker.config.parse_sm_config() -> dict[str, Any]
Parses SageMaker configuration.
funcwandb.integration.sagemaker.resources.parse_sm_secrets() -> dict[str, str]
We read our api_key from secrets.env in SageMaker.
funcwandb.integration.sagemaker.resources.set_global_settings(settings:wandb.Settings) -> None
Set global W&B settings based on the SageMaker environment.
funcwandb.integration.sagemaker.resources.set_run_id(run_settings:wandb.Settings) -> bool
Set a run ID and group when using SageMaker.
classwandb.integration.sb3.sb3.WandbCallback
Callback for logging experiments to Weights and Biases.
funcwandb.integration.tensorboard.log.tf_summary_to_dict(tf_summary_str_or_pb:Any, namespace:str='') -> dict[str, Any] | None
Convert a Tensorboard Summary to a dictionary.
classwandb.integration.torch.wandb_torch.TorchHistory
History methods specific to PyTorch.
methodwandb.integration.torch.wandb_torch.TorchHistory.add_log_parameters_hook(module:Module, name:str='', prefix:str='', log_freq:int=0) -> None
This instruments hooks into the pytorch module.
funcwandb.integration.torch.wandb_torch.log_track_init(log_freq:int) -> list[int]
Create tracking structure used by log_track_update.
classwandb.integration.ultralytics.callback.WandBUltralyticsCallback
Stateful callback for logging to W&B.
funcwandb.integration.weave.interface.active_run_path() -> RunPath | None
Returns the path of an initialized, unfinished run.
funcwandb.integration.weave.weave.init_weave(entity:str | None, project:str | None) -> None
Initialize weave for a W&B entity/project.
methodwandb.integration.xgboost.xgboost.WandbCallback.after_iteration(model:xgb.Booster, epoch:int, evals_log:_EvalsLog) -> bool
Run after each iteration.
methodwandb.integration.xgboost.xgboost.WandbCallback.after_training(model:xgb.Booster) -> xgb.Booster
Run after training is finished.
methodwandb.integration.xgboost.xgboost.WandbCallback.before_training(model:xgb.Booster) -> xgb.Booster
Run before training is finished.
methodwandb.jupyter.Notebook.probe_ipynb()
Return notebook as dict or None.
funcwandb.jupyter.display_if_magic_is_used(run:wandb.Run) -> bool
Display a run's page if the cell has the %%wandb cell magic.
funcwandb.jupyter.notebook_metadata(silent:bool) -> dict[str, str]
Attempt to query jupyter for the path and name of the notebook file.
funcwandb.plot.bar.bar(table:wandb.Table, label:str, value:str, title:str='', split_table:bool=False) -> CustomChart
Constructs a bar chart from a wandb.Table of data.
funcwandb.plot.histogram.histogram(table:wandb.Table, value:str, title:str='', split_table:bool=False) -> CustomChart
Constructs a histogram chart from a W&B Table.
funcwandb.plot.line.line(table:wandb.Table, x:str, y:str, stroke:str | None=None, title:str='', split_table:bool=False) -> CustomChart
Constructs a customizable line chart.
funcwandb.plot.line_series.line_series(xs:Iterable[Iterable[Any]] | Iterable[Any], ys:Iterable[Iterable[Any]], keys:Iterable[str] | None=None, title:str='', xname:str='x', split_table:bool=False) -> CustomChart
Constructs a line series chart.
funcwandb.plot.scatter.scatter(table:wandb.Table, x:str, y:str, title:str='', split_table:bool=False) -> CustomChart
Constructs a scatter plot from a wandb.Table of data.
funcwandb.sandbox._auth.override_sandbox_entity(entity:str | None=None) -> Generator[None]
Temporarily override the sandbox entity for sandbox auth.
classwandb.sandbox._sandbox.Sandbox
W&B sandbox wrapper with W&B Serverless policy guardrails.
classwandb.sandbox._sandbox.Session
W&B sandbox session wrapper with W&B Serverless policy guardrails.
classwandb.sandbox._secret.Secret
W&B sandbox secret with a default team secret store.
funcwandb.sdk.artifacts._gqlutils.org_info_from_entity(service_api:ServiceApi, entity:str) -> FetchOrgInfoFromEntityEntity | None
Returns the organization info for a given entity.
funcwandb.sdk.artifacts._gqlutils.server_supports(service_api:ServiceApi, feature:str | int) -> bool
Return whether the current server supports the given feature.
classwandb.sdk.artifacts._internal_artifact.InternalArtifact
An Artifact intended for internal use only.
funcwandb.sdk.artifacts._internal_artifact.sanitize_artifact_name(name:str) -> str
Sanitize the string to satisfy constraints on artifact names.
classwandb.sdk.artifacts._models.manifest.ArtifactManifestV1Data
Data model for the v1 artifact manifest.
classwandb.sdk.artifacts._models.registry.RegistryData
Transport-free model for local `Registry` data.
methodwandb.sdk.artifacts._validators.ArtifactPath.from_str(path:str) -> Self
Instantiate by parsing a string artifact path.
classwandb.sdk.artifacts._validators.FullArtifactPath
Same as ArtifactPath, but with all parts required.
funcwandb.sdk.artifacts._validators.validate_aliases(aliases:Iterable[str] | str) -> list[str]
Validate the artifact aliases and return them as a list.

About this data

These signatures were extracted from the public source of wandb/wandb using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries