o wi/@sdZddlmZddlZddlmZddlmZmZm Z ddl m Z ddl m Z ddlmZddlZdd lmZdd lmZdd lmZdd lmZdd lmZer^ddlmZddlmZGdddedZGdddeZdS)aW&B Public API for Sweeps. This module provides classes for interacting with W&B hyperparameter optimization sweeps. Example: ```python from wandb.apis.public import Api # Get a specific sweep sweep = Api().sweep("entity/project/sweep_id") # Access sweep properties print(f"Sweep: {sweep.name}") print(f"State: {sweep.state}") print(f"Best Loss: {sweep.best_loss}") # Get best performing run best_run = sweep.best_run() print(f"Best Run: {best_run.name}") print(f"Metrics: {best_run.summary}") ``` Note: This module is part of the W&B Public API and provides read-only access to sweep data. For creating and controlling sweeps, use the wandb.sweep() and wandb.agent() functions from the main wandb package. ) annotationsN)Mapping) TYPE_CHECKINGAnyClassVar)override)gql)Document)util)public)Attrs)SizedPaginator)ipython GetSweeps)RetryingClientcseZdZUdZdZded<ded< d"d#fdd Zed$ddZe ed%ddZ e ed&ddZ e ed'ddZ ed(ddZ d d!ZZS))SweepsaA lazy iterator over a collection of `Sweep` objects. Examples: ```python from wandb.apis.public import Api sweeps = Api().project(name="project_name", entity="entity").sweeps() # Iterate over sweeps and print details for sweep in sweeps: print(f"Sweep name: {sweep.name}") print(f"Sweep ID: {sweep.id}") print(f"Sweep URL: {sweep.url}") print("----------") ``` NzClassVar[Document | None]QUERYzGetSweeps | None last_response2clientrentitystrprojectper_pageintreturncsR|jdurddlm}t|t|_||_||_|j|jd}t|||dS)a6An iterable collection of `Sweep` objects. Args: client: The API client used to query W&B. entity: The entity which owns the sweeps. project: The project which contains the sweeps. per_page: The number of sweeps to fetch per request to the API. Nr)GET_SWEEPS_GQL)rr) rwandb.apis._generatedrrtyperrsuper__init__)selfrrrrr variables __class__L/home/ubuntu/.local/lib/python3.10/site-packages/wandb/apis/public/sweeps.pyr!Is  zSweeps.__init__NonecCs0ddlm}|jj|j|jd}|||_dS)z:Fetch and validate the response data for the current page.rrvariable_valuesN)rrrexecuterr#model_validater)r"rdatar&r&r'_update_responsebs zSweeps._update_responsecCs,|jdur ||jjj}dur|SdS)z^The total number of sweeps in the project. Nr)r _load_pager total_sweeps)r"totalr&r&r'_lengthjs zSweeps._lengthboolcC|jr |jjjjjSdS)zcReturns whether there are more sweeps to fetch. T)rrsweeps page_info has_next_pager"r&r&r'moreyz Sweeps.more str | NonecCr4)zcReturns the cursor for the next page of sweeps. N)rrr5r6 end_cursorr8r&r&r'cursorr:z Sweeps.cursor list[Sweep]csxddlm}ddlm}j}dus|j}dur$dj}t||jdkr+gSfdd|||j  DS) zvConverts the last GraphQL response into a list of `Sweep` objects. r) Connection) SweepFragmentNzCould not find project cs"g|] }tjjj|jqSr&)Sweeprrrname).0noder8r&r' sz*Sweeps.convert_objects..) wandb._pydanticr?rr@rr ValueErrorr0r,r5nodes)r"r?r@rsprmsgr&r8r'convert_objectss     zSweeps.convert_objectscCsd|jd|jdS)Nz)rrr8r&r&r'__repr__szSweeps.__repr__)r) rrrrrrrrrr)rr()rr)rr3)rr;)rr>)__name__ __module__ __qualname____doc__r__annotations__r!rr.propertyr2r9r=rLrO __classcell__r&r&r$r'r4s(      rrBcseZdZdZ d7d8fd d Zed9ddZed9ddZeddZd:d;ddZ eddZ d7ddZ edd+d,Zd?d@d1d2Zd9d3d4Zd9d5d6ZZS)ArBaThe set of runs associated with the sweep. Attributes: runs (Runs): List of runs id (str): Sweep ID project (str): The name of the project the sweep belongs to config (dict): Dictionary containing the sweep configuration state (str): The state of the sweep. Can be "Finished", "Failed", "Crashed", or "Running". expected_run_count (int): The number of expected runs for the sweep Nrrrrrsweep_idattrsMapping[str, Any] | NonecsDtt|pi||_||_||_||_g|_|j| ddS)N)force) r r!dictr_entityridrunsload)r"rrrrWrXr$r&r'r!s zSweep.__init__rcCs|jS)z%The entity associated with the sweep.)r\r8r&r&r'rsz Sweep.entitycCstd|jS)z'Deprecated. Use `Sweep.entity` instead.z>Sweep.username is deprecated. please use Sweep.entity instead.)wandbtermwarnr\r8r&r&r'usernames zSweep.usernamecCst|jdS)z+The sweep configuration used for the sweep.config)r load_yaml_attrsr8r&r&r'rcsz Sweep.configFrZr3cCsJ|s|js"||j|j|j|j}std||j|_|j|_|jS)zxFetch and update sweep data logged to the run from GraphQL database. zCould not find sweep )regetrrrr]rHr^)r"rZsweepr&r&r'r_s z Sweep.loadcCs\|jdr*|jdr,|jddd}|dkrdnd}tj||jddSdSdS) z#Return the order key for the sweep.rcmetricgoalminimize+-rCN)rerfrcr QueryGeneratorformat_order_key)r" sort_orderprefixr&r&r'ordersz Sweep.ordercCs|dur|j}ntj|}|durtdntd|dd|jigi}ztj |j |j |j ||dddWSt yCYdSw) zRReturn the best run sorted by the metric defined in config or the order passed in.NzVNo order specified and couldn't find metric in sweep config, returning most recent runzSorting runs by {}$andrgrA)rqfiltersrr)rqr rmrnr`ratermlogformatr]Runsrrr IndexError)r"rqrsr&r&r'best_runs.  zSweep.best_run int | NonecCs |jdS)zJReturn the number of expected runs in the sweep or None for infinite runs.runCountExpected)rerfr8r&r&r'expected_run_count s zSweep.expected_run_countcCs(tj|jtj|jtj|jgS)zoReturns the path of the project. The path is a list containing the entity, project name, and sweep ID.)urllibparse quote_plusrrr]r8r&r&r'paths   z Sweep.pathcCs$|j}|dd|jjd|S)zThe URL of the sweep. The sweep URL is generated from the entity, project, the term "sweeps", and the sweep ID.run_id. For SaaS users, it takes the form of `https://wandb.ai/entity/project/sweeps/sweeps_ID`. r5rM)rinsertrapp_urljoin)r"rr&r&r'urls z Sweep.urlcCs|jdp|jdp|jS)zThe name of the sweep. Returns the first name that exists in the following priority order: 1. User-edited display name 2. Name configured at creation time 3. Sweep ID displayNamerC)rerfrcr]r8r&r&r'rC(s z Sweep.namer;sidrqqueryDocument | Nonec Ksddlm}m} |s d}|||d|} |durt|}z |j|| d} Wnty9t| }|j|| d} Ynw| rJ| d} rJ| d} sLdS|||||| d }tj||||d d d|j igid |_ |S) aExecute a query against the cloud backend. Args: client: The client to use to execute the query. entity: The entity (username or team) that owns the project. project: The name of the project to fetch sweep from. sid: The sweep ID to query. order: The order in which the sweep's runs are returned. query: The query to use to execute the query. **kwargs: Additional keyword arguments to pass to the query. r) GET_SWEEP_GQLGET_SWEEP_LEGACY_GQLz +created_at)rrrCNr)rrg)rX rr)rqrrs) rrrrr+ Exceptionrfr rvr]r^)clsrrrrrqrkwargsrrr#r- proj_dict sweep_dictrgr&r&r'rf4s:    z Sweep.getheightrhiddencCsF|jd}d|d}d}|r|d7}td}|d|d|d S) z9Generate HTML containing an iframe displaying this sweep.z ?jupyter=truezborder:none;width:100%;height:zpx;z display:none;rgz )rr toggle_button)r"rrrstylerpr&r&r'to_htmlms   z Sweep.to_htmlcCs|SN)rr8r&r&r' _repr_html_wszSweep._repr_html_cCs,d|j}|jdd}d|d|dS)NrMstatez Unknown Statez)rrrerf)r"pathstrrr&r&r'rOzs zSweep.__repr__r) rrrrrrrWrrXrY)rr)F)rZr3)rry)NNNNN) rrrr;rr;rr;rqr;rr)rF)rrrr3rr)rPrQrRrSr!rUrrbrcr_rqrxr{rrrC classmethodrfrrrOrVr&r&r$r'rBs@            8 ) rS __future__rr|collections.abcrtypingrrrtyping_extensionsr wandb_gqlrwandb_graphql.language.astr r`r wandb.apisr wandb.apis.attrsr wandb.apis.paginatorr wandb.sdk.librrrwandb.apis.public.apirrrBr&r&r&r's&            x