o -wiJ@sdZddlZddlZddlZddlZddlmZddlmZm Z m Z m Z m Z m Z mZmZmZddlZddlmZddlmZddlmZmZddlmZddlZdd lmZmZdd lmZdd l m!Z!dd l"m#Z#dd l$m%Z%ddl&m'Z'ddl(m)Z)ddl*m+Z+ddl,m-Z-m.Z.m/Z/m0Z0ddl1m2Z2ddl3m4Z4ddl5m6Z6ddl7m8Z9ddl:m;Z;ddlm?Z?m@Z@ddlAmBZBddlCmDZDerddlEmFZFmGZGmHZHmIZImJZJmKZKmLZLddlMmNZNeOePZQGdddZRGdd d Z8dS)!uZUse the Public API to export or update data that you have saved to W&B. Before using this API, you'll want to log data from your script — check the [Quickstart](https://docs.wandb.ai/quickstart) for more details. You might use the Public API to - update metadata or metrics for an experiment after it has been completed, - pull down your results as a dataframe for post-hoc analysis in a Jupyter notebook, or - check your saved model artifacts for those tagged as `ready-to-deploy`. For more on using the Public API, check out [our guide](https://docs.wandb.com/guides/track/public-api-guide). N) HTTPStatus) TYPE_CHECKINGAnyDictIteratorListLiteralOptionalSetUnion)ValidationError)Unpack)Clientgql) RetryError)envutil)one)public)normalize_exceptions)RETRY_TIMEDELTA)"fetch_org_entity_from_organization) Registries)Registry)PathType!fetch_org_from_settings_or_entity gql_compatparse_org_from_registry_path) Deprecated) ServerFeature)is_artifact_registry_project)Api)_thread_local_api_settings)LAUNCH_DEFAULT_PROJECT)retryrunid) deprecate)GraphQLSession) ActionType Automation EventType Integration NewAutomationSlackIntegrationWebhookIntegration)WriteAutomationsKwargsc@sleZdZedZdefddZeddZe j e e j eejfddd Zed d Zd ed efddZdS)RetryingClienta$ query ServerInfo{ serverInfo { cliVersionInfo latestLocalVersionInfo { outOfDate latestVersionString versionOnThisInstanceString } } } clientcCsd|_||_dSN) _server_info_client)selfr1r6R/home/ubuntu/sommelier/.venv/lib/python3.10/site-packages/wandb/apis/public/api.py__init__]s zRetryingClient.__init__cCst|jjjdddS)Nz/graphql/)rapp_urlr4 transporturlreplacer5r6r6r7r;aszRetryingClient.app_url)retry_timedeltacheck_retry_fnretryable_exceptionsc Os^z |jj|i|WStjjy.d|vr-|jjj}td|d|d|ddw)NtimeoutzGA graphql request initiated by the public wandb API timed out (timeout=z< sec). Create a new API with an integer timeout larger than z!, e.g., `api = wandb.Api(timeout= z#)` to increase the graphql timeout.) r4executerequests exceptions ReadTimeoutr<default_timeoutwandbtermwarn)r5argskwargsrCr6r6r7rEes zRetryingClient.executecCs$|jdur||jd|_|jS)N serverInfo)r3rE INFO_QUERYgetr?r6r6r7 server_infoys zRetryingClient.server_info min_versionreturncCs&ddlm}||||jddkS)Nr)parsecliVersionInfomax_cli_version)packaging.versionrTrQ)r5rRrTr6r6r7version_supporteds  z RetryingClient.version_supportedN)__name__ __module__ __qualname__rrOrr8propertyr;r$ retriablerr no_retry_authrrFRequestExceptionrErQstrboolrXr6r6r6r7r0Ms(   r0c@seZdZdZedZedZedZ edZ edZ   dde e eefd e ed e ed dfd d Zdeded dfddZddddde ede ede ed dfddZ    ddeddde ede dde ede ed dfdd Zdeded!ed"ed#d$ed%d&eeefd efd'd(Z    dded)ed*dde ede ed+e ede dfd,d-Zdd/d0Zdd1d2Zed efd3d4Zed efd5d6Zed e efd7d8Z ed e efd9d:Z!eddd?Z#d@dAZ$dBdCZ%dDdEZ&dFdGZ' Hdde edIed dJfdKdLZ(ddede ed dMfdNdOZ) QddRede edIed dSfdTdUZ*ddVdWZ+dXed dYfdZd[Z,d\ed e d;fd]d^Z-d\ed e.d;fd_d`Z/   a Q bddRe edce e eefddedIedee0f dfdgZ1e2ddhdiZ3  ddjdkZ4dldmZ5e2ddndoZ6e2dde ed dpfdqdrZ7e2 ddsede ed dtfdudvZ8e2 QddwedsedIed dxfdydzZ9e2dseded d{fd|d}Z:e2dd~dZ;e2 Q ddsededIede e.ed df ddZe2dde edRe ed dfddZ?e2deded e.e eeffddZ@e2ddede ed e0fddZAe2deded e0fddZB  dde ede e eefd eCfddZDddede ed eEfddZF   ddededde ede ede e.ed eEf ddZG ddQdde edIed eHdfddZI ddQdde edIed eHdfddZJddQdde edIed eHdfddZKdddde dde dd e0fddZLd eMefddZNdddede ed dfddZO dddQdde ede edIed eHdfddZPe2d.dddde0deQdd dfddZRe2d.dddde0deQdd dfddĄZSe2dedefd edbfddƄZTdS)r!aHUsed for querying the wandb server. Examples: Most common way to initialize >>> wandb.Api() Args: overrides: (dict) You can set `base_url` if you are using a wandb server other than https://api.wandb.ai. You can also set defaults for `entity`, `project`, and `run`. zv query Viewer{ viewer { id entity } } a query Viewer{ viewer { id flags entity username email admin apiKeys { edges { node { id name description } } } teams { edges { node { name } } } } } a query SearchUsers($query: String) { users(query: $query) { edges { node { id flags entity admin email deletedAt username apiKeys { edges { node { id name description } } } teams { edges { node { name } } } } } } } a mutation upsertModel( $description: String $entityName: String $id: String $name: String $framework: String $access: String $views: JSONString ) { upsertModel( input: { description: $description entityName: $entityName id: $id name: $name framework: $framework access: $access views: $views } ) { project { id name entityName description access views } model { id name entityName description access views } inserted } } N overridesrCapi_keyrSc Cs\t|_|p i}|j||jdd|jd<d|vr&|d|jd<d|vr:d|vr:td|d|jd<||_|jdurPtj durPtj | ddd|_ i|_ i|_i|_i|_d|_|durh|n|j|_d}tj svd|jf}|j d pttj d d }tt|jd d tjpid|j|d|jdtj |dd|_t|j|_dS)Nbase_urlr: organizationusernameentityzEPassing "username" to Api is deprecated. please use "entity" instead.)hostapi_proxiesWANDB__PROXIES{}true)z User-AgentzUse-Admin-PrivilegesTz {}/graphql)headersuse_jsonrCauthr=cookiesproxies)r<) InternalApisettingsupdaterstriprJrK_api_keyrdr"rrloginrP_viewer _projects_runs_sweeps_reports_default_entity _HTTP_TIMEOUT_timeoutjsonloadsosenvironrr' user_agentroformat _base_clientr0r4)r5rcrCrd _overridesrqrsr6r6r7r8sV    z Api.__init__namerhcCs|j|j||ddS)zCreate a new project. Args: name: (str) The name of the new project. entity: (str) The entity of the new project. ) entityNamerN)r1rECREATE_PROJECTr5rrhr6r6r7create_projectGszApi.create_projectrun_idprojectrhrrz public.RuncCs"|dur|j}tjj||||dS)aCreate a new run. Args: run_id: (str, optional) The ID to assign to the run, if given. The run ID is automatically generated by default, so in general, you do not need to specify this and should only do so at your own risk. project: (str, optional) If given, the project of the new run. entity: (str, optional) If given, the entity of the new run. Returns: The newly created `Run`. Nr)default_entityrRuncreate)r5rrrhr6r6r7 create_runPszApi.create_runtypezpublic.RunQueueResourceTypeprioritization_modez!public.RunQueuePrioritizationModeconfigtemplate_variableszpublic.RunQueuec Cs(|dur|jdp |j}|durtdt|dkrtdt|dkr(td|dvr0td |r>|}|d vr>td |durDi}|t|t||td t d }t d||ii}| ||||} | dspt d| d} ||t|d|| } | dst dtj|j|||d| |dS)aCreate a new run queue (launch). Args: name: (str) Name of the queue to create type: (str) Type of resource to be used for the queue. One of "local-container", "local-process", "kubernetes", "sagemaker", or "gcp-vertex". entity: (str) Optional name of the entity to create the queue. If None, will use the configured or default entity. prioritization_mode: (str) Optional version of prioritization to use. Either "V0" or None config: (dict) Optional default resource configuration to be used for the queue. Use handlebars (eg. `{{var}}`) to specify template variables. template_variables: (dict) A dictionary of template variable schemas to be used with the config. Expected format of: `{ "var-name": { "schema": { "type": ("string", "number", or "integer"), "default": (optional value), "minimum": (optional minimum), "maximum": (optional maximum), "enum": [..."(options)"] } } }` Returns: The newly created `RunQueue` Raises: ValueError if any of the parameters are invalid wandb.Error on wandb API errors Nrh8entity must be passed as a parameter, or set in settingsrname must be non-empty@$name must be less than 64 characterszlocal-containerz local-process kubernetes sagemakerz gcp-vertexkresource_type must be one of 'local-container', 'local-process', 'kubernetes', 'sagemaker', or 'gcp-vertex')V0z+prioritization_mode must be 'V0' if presentrhrdefault_settingsr@ resource_argssuccessz(failed to create default resource configdefaultResourceConfigIDPROJECTfailed to create run queue)r1rrhr_access_default_resource_config_id_default_resource_config)rur ValueErrorlenupperrr#rtrrrdumpscreate_default_resource_configrJErrorcreate_run_queuerRunQueuer1) r5rrrhrrrrj config_jsoncreate_config_result config_idcreate_queue_resultr6r6r7rfsj'      zApi.create_run_queue display_name spec_typevega2access)privaterspecc CsT|}ttd}|j||||||d} | dus| ddur$td| ddS)aCreate a custom chart preset and return its id. Args: entity: The entity (user or team) that owns the chart name: Unique identifier for the chart preset display_name: Human-readable name shown in the UI spec_type: Type of specification. Must be "vega2" for Vega-Lite v2 specifications. access: Access level for the chart: - "private": Chart is only accessible to the entity that created it - "public": Chart is publicly accessible spec: The Vega/Vega-Lite specification as a dictionary or JSON string Returns: The ID of the created chart preset in the format "entity/name" Raises: wandb.Error: If chart creation fails UnsupportedError: If the server doesn't support custom charts Example: ```python import wandb api = wandb.Api() # Define a simple bar chart specification vega_spec = { "$schema": "https://vega.github.io/schema/vega-lite/v6.json", "mark": "bar", "data": {"name": "wandb"}, "encoding": { "x": {"field": "${field:x}", "type": "ordinal"}, "y": {"field": "${field:y}", "type": "quantitative"}, }, } # Create the custom chart chart_id = api.create_custom_chart( entity="my-team", name="my-bar-chart", display_name="My Custom Bar Chart", spec_type="vega2", access="private", spec=vega_spec, ) # Use with wandb.plot_table() chart = wandb.plot_table( vega_spec_name=chart_id, data_table=my_table, fields={"x": "category", "y": "value"}, ) ``` )r@)rhrrrrrNchartzfailed to create custom chartid)rrtrcreate_custom_chartrPrJr) r5rhrrrrrbackend_accessrjresultr6r6r7rs@   zApi.create_custom_chartresource_config resource_typeexternal_linksc Cs.|dur|jdp |j}|durtdt|dkrtdt|dkr(td|p+d}|}|d vr8td |d vr@td |t|t||td t d}|pUi}ddd| Di}|j |||d||ii|||d} | dszt d| dpg} | D] } t d| qtj|j||dS)aMUpsert a run queue (launch). Args: name: (str) Name of the queue to create entity: (str) Optional name of the entity to create the queue. If None, will use the configured or default entity. resource_config: (dict) Optional default resource configuration to be used for the queue. Use handlebars (eg. `{{var}}`) to specify template variables. resource_type: (str) Type of resource to be used for the queue. One of "local-container", "local-process", "kubernetes", "sagemaker", or "gcp-vertex". template_variables: (dict) A dictionary of template variable schemas to be used with the config. Expected format of: `{ "var-name": { "schema": { "type": ("string", "number", or "integer"), "default": (optional value), "minimum": (optional minimum), "maximum": (optional maximum), "enum": [..."(options)"] } } }` external_links: (dict) Optional dictionary of external links to be used with the queue. Expected format of: `{ "name": "url" }` prioritization_mode: (str) Optional version of prioritization to use. Either "V0" or None Returns: The upserted `RunQueue`. Raises: ValueError if any of the parameters are invalid wandb.Error on wandb API errors NrhrrrrrDISABLED)rrz9prioritization_mode must be 'V0' or 'DISABLED' if presentrrrrlinkscSsg|] \}}||dqS))labelr=r6).0keyvaluer6r6r7 ys z(Api.upsert_run_queue..r)rrrrrconfigSchemaValidationErrorszresource config validation: )r1rrh)rurrrrrr#rtrritemsupsert_run_queuerJrrPrKrrr1) r5rrrrhrrrrjupsert_run_queue_result schema_errorserrorr6r6r7r%sh*        zApi.upsert_run_queueFcCtj|||S)zCreate a new user. Args: email: (str) The email address of the user admin: (bool) Whether this user should be a global instance admin Returns: A `User` object )rUserr)r5emailadminr6r6r7 create_user zApi.create_userc Csddlm}|p t}|p|jdpd}|p|j}||||d|jjdddd}| || | s>| }| r6| d|||gS) z9Sync a local directory containing tfevent files to wandb.r) SyncManagerr uncategorizedFT)rrhr mark_syncedr;viewverbosesync_tensorboardr:) wandb.syncrr% generate_idrurPrr1r;addstartis_donepollrunjoin)r5root_dirrrrhrsm_r6r6r7rs(    zApi.sync_tensorboardcCs|jSr2)r4r?r6r6r7r1sz Api.clientcCs dtjS)NzW&B Public Client {})rrJ __version__r?r6r6r7rs zApi.user_agentcCs\tjrtjS|jdur|jStj|jd}d}|r|d}tdr)tj d}||_|S)Nre WANDB_API_KEY) r"rdrxrFutilsget_netrc_authrurgetenvr)r5rqrr6r6r7rds   z Api.api_keycCs4|jdur|j|j}|dpid|_|jS)Nviewerrh)rr4rEDEFAULT_ENTITY_QUERYrP)r5resr6r6r7rs zApi.default_entity public.UsercCs:|jdurt|j|j|jd|_|jj|_|jS)Nr) rzrrr4rE VIEWER_QUERYrPrhrr?r6r6r7rs  z Api.viewercCs i|_dS)a Flush the local cache. The api object keeps a local cache of runs, so if the state of the run may change while executing your script you must clear the local cache with `api.flush()` to get the latest values associated with the run. N)r|r?r6r6r7flushs z Api.flushc Cs&|dd}t|dkr||St|dkr#||d|dSt|dkr.||St|dkr|ddr@||S|dd rL||S|dd rd |d vrld |d vrdtdd |d |d <|d d \}}t |j t j |d d|dd|d|dStd)aReturn a run, sweep, project or report from a path. Examples: ``` project = api.from_path("my_project") team_project = api.from_path("my_team/my_project") run = api.from_path("my_team/my_project/runs/id") sweep = api.from_path("my_team/my_project/sweeps/id") report = api.from_path("my_team/my_project/reports/My-Report-Vm11dsdf") ``` Args: path: (str) The path to the project, run, sweep or report Returns: A `Project`, `Run`, `Sweep`, or `BetaReport` instance. Raises: wandb.Error if path is invalid or the object doesn't exist / r:rrsweepreportz--r-z>Invalid report path, should be team/project/reports/Name--XXXX rm) displayNamerrzSInvalid path, should be TEAM/PROJECT/TYPE/ID where TYPE is runs, sweeps, or reports)stripsplitrrr startswithrrJrr BetaReportr1urllibrTunquoter>)r5pathpartsrrr6r6r7 from_paths@           z Api.from_pathcCsR|jdpd}|jdp|j}|dur||fS|dd}t|dkr'||fS|S)z8Return project and entity for project specified by path.rrrhNr:r)rurrr)r5rrrhr r6r6r7_parse_project_path&s  zApi._parse_project_pathcCs|jdpd}|jdp|j}|dddddd}d|d vr:|d dd }|d dd |d <n|d rB|d }t|d krM|dkrMn(t|d krq|d }|rb||krb|d }n|d }t|d krp|d }n|d }|||fS) aParse url, filepath, or docker paths. Allows paths in the following formats: - url: entity/project/runs/id - path: entity/project/id - docker: entity/project:id Entity is optional and will fall back to the current logged-in user. rrrhz/runs/r:z/sweeps/r:rrrr)rurr>rrr)r5rrrhr rr6r6r7 _parse_path1s*       zApi._parse_pathcCs|jdpd}|jdp|j}|dur||fS|d\}}}||}|d}t|dkr5td|t|d krB||||fSt|d krS||d |d |fS|d |7<|S) zGReturn project, entity and artifact name for project specified by path.rrrhNr r:rzInvalid artifact path: {}rrrr)rur partitionrrrr)r5rrrhcolonalias full_aliasr r6r6r7_parse_artifact_pathSs    zApi._parse_artifact_pathper_pagezpublic.ProjectscCsT|dur|jdp |j}|durtd||jvr%tj|j||d|j|<|j|S)aGet projects for a given entity. Args: entity: (str) Name of the entity requested. If None, will fall back to the default entity passed to `Api`. If no default entity, will raise a `ValueError`. per_page: (int) Sets the page size for query pagination. Usually there is no reason to change this. Returns: A `Projects` object which is an iterable collection of `Project` objects. Nrhrr)rurrr{rProjectsr1)r5rhrr6r6r7projectsgs   z Api.projectszpublic.ProjectcCsbt|r|nd}|dur|jdp|j}t|r(|jdp|j}tj||d}t|j||iS)anReturn the `Project` with the given name (and entity, if given). Args: name: (str) The project name. entity: (str) Name of the entity requested. If None, will fall back to the default entity passed to `Api`. If no default entity, will raise a `ValueError`. Returns: A `Project` object. r9Nrhrhrf)r rurrt_resolve_org_entity_namerProjectr1)r5rrhorgsettings_entityr6r6r7rs z Api.projectr92rzpublic.ReportscCs||d\}}}|rtj|}d||t|g}nd||g}||jvr=tj|j t |j ||i||d|j|<|j|S)aGet reports for a given project path. WARNING: This api is in beta and will likely change in a future release Args: path: (str) path to project the report resides in, should be in the form: "entity/project" name: (str, optional) optional name of the report requested. per_page: (int) Sets the page size for query pagination. Usually there is no reason to change this. Returns: A `Reports` object which is an iterable collection of `BetaReport` objects. z /fake_runr:rr) r rrTrrr`r~rReportsr1r)r5rrrrhrrrr6r6r7reportss   z Api.reportscCr)zCreate a new team. Args: team: (str) The name of the team admin_username: (str) optional username of the admin user of the team, defaults to the current user. Returns: A `Team` object )rTeamr)r5teamadmin_usernamer6r6r7 create_teamrzApi.create_teamr"z public.TeamcCst|j|S)zReturn the matching `Team` with the given name. Args: team: (str) The name of the team. Returns: A `Team` object. )rr!r1)r5r"r6r6r7r"s zApi.teamusername_or_emailcCsn|j|jd|i}t|dddkrdSt|dddkr(td|t|j|ddddS) ajReturn a user from a username or email address. Note: This function only works for Local Admins, if you are trying to get your own user object, please use `api.viewer`. Args: username_or_email: (str) The username or email address of the user Returns: A `User` object or None if a user couldn't be found queryusersedgesrNrz:Found multiple users, returning the first user matching {}node) r4rE USERS_QUERYrrJrKrrrr5r%rr6r6r7users zApi.usercs.jjd|i}fdd|ddDS)ajReturn all users from a partial username or email address query. Note: This function only works for Local Admins, if you are trying to get your own user object, please use `api.viewer`. Args: username_or_email: (str) The prefix or suffix of the user you want to find Returns: An array of `User` objects r&csg|] }tj|dqS)r))rrr4)redger?r6r7rszApi.users..r'r()r4rEr*r+r6r?r7r's  z Api.users +created_atTfiltersorderinclude_sweepsc Csd||\}}|p i}|pdt|t|}|j|s-tj|j||||||d|j|<|j|S)aReturn a set of runs from a project that match the filters provided. Fields you can filter by include: - `createdAt`: The timestamp when the run was created. (in ISO 8601 format, e.g. "2023-01-01T12:00:00Z") - `displayName`: The human-readable display name of the run. (e.g. "eager-fox-1") - `duration`: The total runtime of the run in seconds. - `group`: The group name used to organize related runs together. - `host`: The hostname where the run was executed. - `jobType`: The type of job or purpose of the run. - `name`: The unique identifier of the run. (e.g. "a1b2cdef") - `state`: The current state of the run. - `tags`: The tags associated with the run. - `username`: The username of the user who initiated the run Additionally, you can filter by items in the run config or summary metrics. Such as `config.experiment_name`, `summary_metrics.loss`, etc. For more complex filtering, you can use MongoDB query operators. For details, see: https://docs.mongodb.com/manual/reference/operator/query The following operations are supported: - `$and` - `$or` - `$nor` - `$eq` - `$ne` - `$gt` - `$gte` - `$lt` - `$lte` - `$in` - `$nin` - `$exists` - `$regex` Examples: Find runs in my_project where config.experiment_name has been set to "foo" ``` api.runs( path="my_entity/my_project", filters={"config.experiment_name": "foo"}, ) ``` Find runs in my_project where config.experiment_name has been set to "foo" or "bar" ``` api.runs( path="my_entity/my_project", filters={ "$or": [ {"config.experiment_name": "foo"}, {"config.experiment_name": "bar"}, ] }, ) ``` Find runs in my_project where config.experiment_name matches a regex (anchors are not supported) ``` api.runs( path="my_entity/my_project", filters={"config.experiment_name": {"$regex": "b.*"}}, ) ``` Find runs in my_project where the run name matches a regex (anchors are not supported) ``` api.runs( path="my_entity/my_project", filters={"display_name": {"$regex": "^foo.*"}}, ) ``` Find runs in my_project where config.experiment contains a nested field "category" with value "testing" ``` api.runs( path="my_entity/my_project", filters={"config.experiment.category": "testing"}, ) ``` Find runs in my_project with a loss value of 0.5 nested in a dictionary under model1 in the summary metrics ``` api.runs( path="my_entity/my_project", filters={"summary_metrics.model1.loss": 0.5}, ) ``` Find runs in my_project sorted by ascending loss ``` api.runs(path="my_entity/my_project", order="+summary_metrics.loss") ``` Args: path: (str) path to project, should be in the form: "entity/project" filters: (dict) queries for specific runs using the MongoDB query language. You can filter by run properties such as config.key, summary_metrics.key, state, entity, createdAt, etc. For example: `{"config.experiment_name": "foo"}` would find runs with a config entry of experiment name set to "foo" order: (str) Order can be `created_at`, `heartbeat_at`, `config.*.value`, or `summary_metrics.*`. If you prepend order with a + order is ascending. If you prepend order with a - order is descending (default). The default order is run.created_at from oldest to newest. per_page: (int) Sets the page size for query pagination. include_sweeps: (bool) Whether to include the sweep runs in the results. Returns: A `Runs` object, which is an iterable collection of `Run` objects. r9)r/r0rr1)r r`r|rPrRunsr1) r5rr/r0rr1rhrrr6r6r7runssv  zApi.runscC>||\}}}|j|st|j||||j|<|j|S)aoReturn a single run by parsing path in the form entity/project/run_id. Args: path: (str) path to run in the form `entity/project/run_id`. If `api.entity` is set, this can be in the form `project/run_id` and if `api.project` is set this can just be the run_id. Returns: A `Run` object. )r r|rPrrr1)r5rrhrrr6r6r7r{  zApi.runc Cstj|j||||||dS)zReturn a single queued run based on the path. Parses paths of the form entity/project/queue_id/run_queue_item_id. ) project_queuepriority)r QueuedRunr1)r5rhr queue_namerun_queue_item_idr6r7r6r6r7 queued_runs zApi.queued_runcCst|j||S)z~Return the named `RunQueue` for entity. To create a new `RunQueue`, use `wandb.Api().create_run_queue(...)`. )rrr1)r5rhrr6r6r7 run_queues  z Api.run_queuecCr4)aReturn a sweep by parsing path in the form `entity/project/sweep_id`. Args: path: (str, optional) path to sweep in the form entity/project/sweep_id. If `api.entity` is set, this can be in the form project/sweep_id and if `api.project` is set this can just be the sweep_id. Returns: A `Sweep` object. )r r}rPrSweepr1)r5rrhrsweep_idr6r6r7rr5z Api.sweepzpublic.ArtifactTypescCsV|}||\}}t|r#|jdp|j}t|tj}tj||d}t |j ||S)zReturn a collection of matching artifact types. Args: project: (str, optional) If given, a project name or path to filter on. Returns: An iterable `ArtifactTypes` object. rhr) r r rurrrrrtrr ArtifactTypesr1)r5r project_pathrhrrr6r6r7artifact_typess  zApi.artifact_types type_namezpublic.ArtifactTypecCsX|}||\}}t|r#t|tj}|jdp|j}tj||d}t |j |||S)aReturn the matching `ArtifactType`. Args: type_name: (str) The name of the artifact type to retrieve. project: (str, optional) If given, a project name or path to filter on. Returns: An `ArtifactType` object. rhr) r r rrrrurrtrr ArtifactTyper1)r5rBrr@rhrrr6r6r7 artifact_types  zApi.artifact_type project_namezpublic.ArtifactCollectionscCsX||\}}t|r!t|tj}|jdp|j}tj||d}t j |j ||||dS)aReturn a collection of matching artifact collections. Args: project_name: (str) The name of the project to filter on. type_name: (str) The name of the artifact type to filter on. per_page: (int) Sets the page size for query pagination. Usually there is no reason to change this. Returns: An iterable `ArtifactCollections` object. rhrr) r r rrrrurrtrrArtifactCollectionsr1)r5rErBrrhrrrr6r6r7artifact_collectionss  zApi.artifact_collectionszpublic.ArtifactCollectioncCsh||\}}}t|r"t|tj}|jdp|j}tj||d}|dur*t dt |j ||||S)aVReturn a single artifact collection by type and parsing path in the form `entity/project/name`. Args: type_name: (str) The type of artifact collection to fetch. name: (str) An artifact collection name. May be prefixed with entity/project. Returns: An `ArtifactCollection` object. rhrNzZCould not determine entity. Please include the entity as part of the collection name path.) rr rrARTIFACTrurrtrrrArtifactCollectionr1)r5rBrrhrcollection_namerrr6r6r7artifact_collection s   zApi.artifact_collectioncCsttjdd|j|||dS)z5Deprecated, use `artifacts(type_name, name)` instead.zaApi.artifact_versions(type_name, name) is deprecated, use Api.artifacts(type_name, name) instead.) field_namewarning_messager)r&rapi__artifact_versions artifacts)r5rBrrr6r6r7artifact_versions)s zApi.artifact_versionstagszpublic.Artifactsc Cs^||\}}}t|r"t|tj}|jdp|j} tj| |d}t j |j ||||||dS)aReturn an `Artifacts` collection from the given parameters. Args: type_name: (str) The type of artifacts to fetch. name: (str) An artifact collection name. May be prefixed with entity/project. per_page: (int) Sets the page size for query pagination. Usually there is no reason to change this. tags: (list[str], optional) Only return artifacts with all of these tags. Returns: An iterable `Artifacts` object. rhr)rrQ) rr rrrHrurrtrr Artifactsr1) r5rBrrrQrhrrJrrr6r6r7rO5s  z Api.artifactsenable_trackingc Cs|durtd||\}}}t|r7|ddkr"|ddn|jd}|jdp.|j}tj||d}|dur?tdt j j ||||j |d } |dur_| j |kr_td |d | j | S) Nz,You must specify name= to fetch an artifact.r:rrrfrhrzXCould not determine entity. Please include the entity as part of the artifact name path.)rhrrr1rSztype z( specified but this artifact is of type )rrr countrrurrtrrJArtifact _from_namer1r) r5rrrSrhr artifact_namerfrartifactr6r6r7 _artifactZs8z Api._artifactcCs|j||ddS)aiReturn a single artifact by parsing path in the form `project/name` or `entity/project/name`. Args: name: (str) An artifact name. May be prefixed with project/ or entity/project/. If no entity is specified in the name, the Run or API setting's entity is used. Valid names can be in the following forms: name:version name:alias type: (str, optional) The type of artifact to fetch. Returns: An `Artifact` object. Raises: ValueError: If the artifact name is not specified. ValueError: If the artifact type is specified but does not match the type of the fetched artifact. Note: This method is intended for external use only. Do not call `api.artifact()` within the wandb repository code. T)rrrS)rYr5rrr6r6r7rXsz Api.artifactz public.JobcCs<|durtd|ddksd|vrtdt|||S)zReturn a `Job` from the given parameters. Args: name: (str) The job name. path: (str, optional) If given, the root path in which to download the job artifact. Returns: A `Job` object. Nz&You must specify name= to fetch a job.r:rr zfInvalid job specification. A job must be of the form: //:)rrTrJob)r5rrr6r6r7jobs zApi.jobcCs|durtd|durtdtd}z=|j|||dd}|r&|ds5td|d |d gWS|dd dur@gWS|dd d d }dd|DWStjjy]YdSw)a Return a list of jobs, if any, for the given entity and project. Args: entity: (str) The entity for the listed job(s). project: (str) The project for the listed job(s). Returns: A list of matching jobs. Nz#Specify an entity when listing jobsz#Specify a project when listing jobsa query ArtifactOfType( $entityName: String!, $projectName: String!, $artifactTypeName: String!, ) { project(name: $projectName, entityName: $entityName) { artifactType(name: $artifactTypeName) { artifactCollections { edges { node { artifacts { edges { node { id state aliases { alias } artifactSequence { name } } } } } } } } } } r\) projectNamerartifactTypeNamerz Project: 'z' not found in entity: 'z' or access denied. artifactTypeartifactCollectionsr(cSsg|]}|ddqS)r)rOr6)rxr6r6r7rsz!Api.list_jobs..F) rrr4rErJ termerrorrFrG HTTPError)r5rhrr&artifact_queryrOr6r6r7 list_jobss> #  z Api.list_jobscCs,z |||WdStjjyYdSw)aReturn whether an artifact version exists within a specified project and entity. Args: name: (str) An artifact name. May be prefixed with entity/project. If entity or project is not specified, it will be inferred from the override params if populated. Otherwise, entity will be pulled from the user settings and project will default to "uncategorized". Valid names can be in the following forms: name:version name:alias type: (str, optional) The type of artifact Returns: True if the artifact version exists, False otherwise. FT)rYrJerrors CommErrorrZr6r6r7artifact_existss zApi.artifact_existscCs,z |||WdStjjyYdSw)a;Return whether an artifact collection exists within a specified project and entity. Args: name: (str) An artifact collection name. May be prefixed with entity/project. If entity or project is not specified, it will be inferred from the override params if populated. Otherwise, entity will be pulled from the user settings and project will default to "uncategorized". type: (str) The type of artifact collection Returns: True if the artifact collection exists, False otherwise. FT)rKrJrfrgrZr6r6r7artifact_collection_existss  zApi.artifact_collection_existsrffiltercCs6ttjs td|pt|j|j}t|j ||S)akReturns a Registry iterator. Use the iterator to search and filter registries, collections, or artifact versions across your organization's registry. Examples: Find all registries with the names that contain "model" ```python import wandb api = wandb.Api() # specify an org if your entity belongs to multiple orgs api.registries(filter={"name": {"$regex": "model"}}) ``` Find all collections in the registries with the name "my_collection" and the tag "my_tag" ```python api.registries().collections( filter={"name": "my_collection", "tag": "my_tag"} ) ``` Find all artifact versions in the registries with a collection name that contains "my_collection" and a version that has the alias "best" ```python api.registries().collections( filter={"name": {"$regex": "my_collection"}} ).versions(filter={"alias": "best"}) ``` Find all artifact versions in the registries that contain "model" and have the tag "prod" or alias "best" ```python api.registries(filter={"name": {"$regex": "model"}}).versions( filter={"$or": [{"tag": "prod"}, {"alias": "best"}]} ) ``` Args: organization: (str, optional) The organization of the registry to fetch. If not specified, use the organization specified in the user's settings. filter: (dict, optional) MongoDB-style filter to apply to each object in the registry iterator. Fields available to filter for collections are `name`, `description`, `created_at`, `updated_at`. Fields available to filter for collections are `name`, `tag`, `description`, `created_at`, `updated_at` Fields available to filter for versions are `tag`, `alias`, `created_at`, `updated_at`, `metadata` Returns: A registry iterator. zRegistry search API is not enabled on this wandb server version. Please upgrade your server version or contact support at support@wandb.com.) rt_server_supportsrARTIFACT_REGISTRY_SEARCH RuntimeErrorrrurrr1)r5rfrjr6r6r7 registries's6zApi.registriescCsPttjs td|pt|j|j}t|j |}t |j |||}| |S)aReturn a registry given a registry name. Args: name: The name of the registry. This is without the `wandb-registry-` prefix. organization: The organization of the registry. If no organization is set in the settings, the organization will be fetched from the entity if the entity only belongs to one organization. Returns: A registry object. Examples: Fetch and update a registry ```python import wandb api = wandb.Api() registry = api.registry(name="my-registry", organization="my-org") registry.description = "This is an updated description" registry.save() ``` zapi.registry() is not enabled on this wandb server version. Please upgrade your server version or contact support at support@wandb.com.) rtrkrrlrmrrurrr1rload)r5rrf org_entityregistryr6r6r7rqhs z Api.registry visibility)rf restricted descriptionrAcCsttjs td|pt|j|j}z |j||d}Wn t y(d}Ynw|r6t d|d|dt |j |||||S)aCreate a new registry. Args: name: The name of the registry. Name must be unique within the organization. visibility: The visibility of the registry. organization: Anyone in the organization can view this registry. You can edit their roles later from the settings in the UI. restricted: Only invited members via the UI can access this registry. Public sharing is disabled. organization: The organization of the registry. If no organization is set in the settings, the organization will be fetched from the entity if the entity only belongs to one organization. description: The description of the registry. artifact_types: The accepted artifact types of the registry. A type is no more than 128 characters and do not include characters `/` or `:`. If not specified, all types are accepted. Allowed types added to the registry cannot be removed later. Returns: A registry object. Examples: ```python import wandb api = wandb.Api() registry = api.create_registry( name="my-registry", visibility="restricted", organization="my-org", description="This is a test registry", artifact_types=["model"], ) ``` zcreate_registry api is not enabled on this wandb server version. Please upgrade your server version or contact support at support@wandb.com.)rrfNz Registry z already exists in organization z, please use a different name.) rtrkr+INCLUDE_ARTIFACT_TYPES_IN_REGISTRY_CREATIONrmrrurrqrrrr1)r5rrrrfrtrAexisting_registryr6r6r7create_registrys4+ zApi.create_registryrr+cC*ddlm}d|p |ji}||j||dS)aReturn an iterator of all integrations for an entity. Args: entity: The entity (e.g. team name) for which to fetch integrations. If not provided, the user's default entity will be used. per_page: Number of integrations to fetch per page. Defaults to 50. Usually there is no reason to change this. Yields: Iterator[SlackIntegration | WebhookIntegration]: An iterator of any supported integrations. r) Integrationsrr1 variablesr)wandb.apis.public.integrationsryrr1)r5rhrryparamsr6r6r7 integrationss zApi.integrationsr.cCrx)azReturns an iterator of webhook integrations for an entity. Args: entity: The entity (e.g. team name) for which to fetch integrations. If not provided, the user's default entity will be used. per_page: Number of integrations to fetch per page. Defaults to 50. Usually there is no reason to change this. Yields: Iterator[WebhookIntegration]: An iterator of webhook integrations. Examples: Get all registered webhook integrations for the team "my-team": ```python import wandb api = wandb.Api() webhook_integrations = api.webhook_integrations(entity="my-team") ``` Find only webhook integrations that post requests to "https://my-fake-url.com": ```python webhook_integrations = api.webhook_integrations(entity="my-team") my_webhooks = [ ig for ig in webhook_integrations if ig.url_endpoint.startswith("https://my-fake-url.com") ] ``` r)WebhookIntegrationsrrz)r|rrr1)r5rhrrr}r6r6r7webhook_integrations "zApi.webhook_integrations)rhrr-cCrx)aoReturns an iterator of Slack integrations for an entity. Args: entity: The entity (e.g. team name) for which to fetch integrations. If not provided, the user's default entity will be used. per_page: Number of integrations to fetch per page. Defaults to 50. Usually there is no reason to change this. Yields: Iterator[SlackIntegration]: An iterator of Slack integrations. Examples: Get all registered Slack integrations for the team "my-team": ```python import wandb api = wandb.Api() slack_integrations = api.slack_integrations(entity="my-team") ``` Find only Slack integrations that post to channel names starting with "team-alerts-": ```python slack_integrations = api.slack_integrations(entity="my-team") team_alert_integrations = [ ig for ig in slack_integrations if ig.channel_name.startswith("team-alerts-") ] ``` r)SlackIntegrationsrrz)r|rrr1)r5rhrrr}r6r6r7slack_integrationsrzApi.slack_integrationseventactionrr*rr(cCsbddlm}m}t}|dup||vp|d|j}|dup,||vp,|d|j}|o0|S)zIReturns whether the server recognizes the automation event and/or action.r)ALWAYS_SUPPORTED_ACTIONSALWAYS_SUPPORTED_EVENTSNAUTOMATION_EVENT_AUTOMATION_ACTION_)wandb.automations._utilsrrrtrkr)r5rrrrrjsupports_eventsupports_actionr6r6r7_supports_automationAszApi._supports_automationcsbddlm}ddlm}m}m}m}|j|j|j |j|j |j|j |jit fdd|DS)aReturns the names of unsupported automation-related fragments. Older servers won't recognize newer GraphQL types, so a valid request may unnecessarily error out because it won't recognize fragments defined on those types. So e.g. if a server does not support `NO_OP` action types, then the following need to be removed from the body of the GraphQL request: - Fragment definition: ``` fragment NoOpActionFields on NoOpTriggeredAction { noOp } ``` - Fragment spread in selection set: ``` { ...NoOpActionFields # ... other fields ... } ``` r)r()GenericWebhookActionFieldsNoOpActionFieldsNotificationActionFieldsQueueJobActionFieldsc3s.|]}j|ds|rVqdS)rN)rrP)rrfragment_namesrr5r6r7 s   z4Api._omitted_automation_fragments..) wandb.automationsr(wandb.automations._generatedrrrrNO_OPrY QUEUE_JOB NOTIFICATIONGENERIC_WEBHOOKset)r5r(rrrrr6rr7_omitted_automation_fragmentsZs  z!Api._omitted_automation_fragments)rhr)cCs t|j||dtdtddS)aReturns the only Automation matching the parameters. Args: name: The name of the automation to fetch. entity: The entity to fetch the automation for. Raises: ValueError: If zero or multiple Automations match the search criteria. Examples: Get an existing automation named "my-automation": ```python import wandb api = wandb.Api() automation = api.automation(name="my-automation") ``` Get an existing automation named "other-automation", from the entity "my-team": ```python automation = api.automation(name="other-automation", entity="my-team") ``` )rhrzNo automations foundzMultiple automations found) too_shorttoo_long)r automationsrrr6r6r7 automations  zApi.automationrc #sddlm}ddlm}m}d|i}|dur|}n|}|} t|| d} ||j||| d} durs z!Api.automations..) wandb.apis.public.automationsrrrrrrr1rj) r5rhrrrrrr{gql_strrr&iteratorr6rr7rs   zApi.automations)fetch_existingobjr,rrMr/c Ksddlm}ddlm}m}ddlm}||fi|}|j|j} |j } ds4t d| d| d| } t || d } d |j d d i} |j}z |jj| | d }Wn9tjy}z,t|jj}|tjur|r~td|d|j|dWYd}~St d|ddd}~wwz||j}Wnty}z d|}t||d}~ww|dus|jdurd|}t|||jS)aCreate a new Automation. Args: obj: The automation to create. fetch_existing: If True, and a conflicting automation already exists, attempt to fetch the existing automation instead of raising an error. **kwargs: Any additional values to assign to the automation before creating it. If given, these will override any values that may already be set on the automation: - `name`: The name of the automation. - `description`: The description of the automation. - `enabled`: Whether the automation is enabled. - `scope`: The scope of the automation. - `event`: The event that triggers the automation. - `action`: The action that is triggered by the automation. Returns: The saved Automation. Examples: Create a new automation named "my-automation" that sends a Slack notification when a run within a specific project logs a metric exceeding a custom threshold: ```python import wandb from wandb.automations import OnRunMetric, RunEvent, SendNotification api = wandb.Api() project = api.project("my-project", entity="my-team") # Use the first Slack integration for the team slack_hook = next(api.slack_integrations(entity="my-team")) event = OnRunMetric( scope=project, filter=RunEvent.metric("custom-metric") > 10, ) action = SendNotification.from_integration(slack_hook) automation = api.create_automation( event >> action, name="my-automation", description="Send a Slack message whenever 'custom-metric' exceeds 10.", ) ``` r)r))CREATE_AUTOMATION_GQLCreateAutomation)prepare_to_createrAutomation event or action ( -> }) is not supported on this wandb server version. Please upgrade your server version, or contact support at support@wandb.com.rr}T exclude_nonevariable_values Automation z exists. Fetching it instead.rNz5 exists. Unable to create another with the same name.z+Invalid response while creating automation z)Empty response while creating automation )rr)rrrrrrtriggering_event_typetriggered_action_typerrr model_dumprr1rErFrcrresponse status_codeCONFLICTrJtermlogrmodel_validaterr rmtrigger)r5rrrMr)rrr gql_inputrrrmutationr{rdataestatusrmsgr6r6r7create_automationsT :          zApi.create_automation)create_missingrc Ksddlm}m}ddlm}m}ddlm}|j|j ds!t d||fi|} |j| j } | j } dsCt d| jd | jd |} t|| d } d | jd di}| j}z |jj| |d}WnEtjy}z8t|jj}|tjur|rtd|d||WYd}~St d|d|td|d|jjd}~wwz| |j!}Wnt"y}z d|}t ||d}~ww|dus|j#durd|}t || |j#S)aUpdate an existing automation. Args: obj: The automation to update. Must be an existing automation. create_missing (bool): If True, and the automation does not exist, create it. **kwargs: Any additional values to assign to the automation before updating it. If given, these will override any values that may already be set on the automation: - `name`: The name of the automation. - `description`: The description of the automation. - `enabled`: Whether the automation is enabled. - `scope`: The scope of the automation. - `event`: The event that triggers the automation. - `action`: The action that is triggered by the automation. Returns: The updated automation. Examples: Disable and edit the description of an existing automation ("my-automation"): ```python import wandb api = wandb.Api() automation = api.automation(name="my-automation") automation.enabled = False automation.description = "Kept for reference, but no longer used." updated_automation = api.update_automation(automation) ``` OR: ```python import wandb api = wandb.Api() automation = api.automation(name="my-automation") updated_automation = api.update_automation( automation, enabled=False, description="Kept for reference, but no longer used.", ) ``` r)r(r))UPDATE_AUTOMATION_GQLUpdateAutomation)prepare_to_updaterzUpdating existing automations is not enabled on this wandb server version. Please upgrade your server version, or contact support at support@wandb.com.rrrrrr}Trrrz not found. Creating it.Nz not found. Unable to edit it.zGot response status z: z+Invalid response while updating automation z)Empty response while updating automation )$rr(r)rrrrrrrrmrrrrrrrrr1rErFrcrrr NOT_FOUNDrJrrrbtextrrr r)r5rrrMr(r)rrrrrrrrr{rrrrrrr6r6r7update_automationRs^;         zApi.update_automationc Csddlm}m}ddlm}||}t|}d|i}|jj||d}z||j } Wnt y@} z d|} t | | d} ~ ww| durNd|} t | | j sXt d || j S) zDelete an automation. Args: obj: The automation to delete, or its ID. Returns: True if the automation was deleted successfully. r)DELETE_AUTOMATION_GQLDeleteAutomation) extract_idrrz+Invalid response while deleting automation Nz)Empty response while deleting automation zFailed to delete automation: ) rrrrrrr1rErrr rmr) r5rrrrid_rr{rrrrr6r6r7delete_automations&    zApi.delete_automation)NNN)NNNN)F)rSr)Nrr2)r9Nr)NNr.rT)r9)NN)r)rN)NF)UrYrZr[__doc__rget_http_timeoutrrrrr*rr rr`rintr8rrdictrrr rrrrr\r0r1rrdrrrr r r rrrr r$r"r,rr'rar3rrr;r<rrArDrGrKrPrOrYrXr\rerhrirrnrrqrwrr~rrrr rrrr rrrr6r6r6r7r!s  $. 7   p  T s   8 "               $ ("$M A*  L  * , 4 ' 8 j y$r!)Srrloggingrrhttprtypingrrrrrrr r r rFpydanticr typing_extensionsr wandb_gqlrrwandb_gql.clientrrJrrwandb._iterutilsr wandb.apisrwandb.apis.normalizerwandb.apis.public.constr#wandb.apis.public.registries._utilsr.wandb.apis.public.registries.registries_searchr%wandb.apis.public.registries.registryrwandb.apis.public.utilsrrrrwandb.proto.wandb_deprecatedrwandb.proto.wandb_internal_pb2rwandb.sdk.artifacts._validatorsr wandb.sdk.internal.internal_apir!rt(wandb.sdk.internal.thread_local_settingsr"wandb.sdk.launch.utilsr# wandb.sdk.libr$r%wandb.sdk.lib.deprecater&wandb.sdk.lib.gql_requestr'rr(r)r*r+r,r-r.rr/ getLoggerrYloggerr0r6r6r6r7sJ  ,                  $ <