File size: 6,547 Bytes
9c6594c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
"""Public API: sweeps."""
import urllib
from typing import Optional
from wandb_gql import gql
import wandb
from wandb import util
from wandb.apis import public
from wandb.apis.attrs import Attrs
from wandb.sdk.lib import ipython
SWEEP_FRAGMENT = """fragment SweepFragment on Sweep {
id
name
method
state
description
displayName
bestLoss
config
createdAt
updatedAt
runCount
}
"""
class Sweep(Attrs):
"""A set of runs associated with a sweep.
Examples:
Instantiate with:
```
api = wandb.Api()
sweep = api.sweep(path / to / sweep)
```
Attributes:
runs: (`Runs`) list of runs
id: (str) sweep id
project: (str) name of project
config: (str) dictionary of sweep configuration
state: (str) the state of the sweep
expected_run_count: (int) number of expected runs for the sweep
"""
QUERY = gql(
"""
query Sweep($project: String, $entity: String, $name: String!) {
project(name: $project, entityName: $entity) {
sweep(sweepName: $name) {
id
name
state
runCountExpected
bestLoss
config
}
}
}
"""
)
LEGACY_QUERY = gql(
"""
query Sweep($project: String, $entity: String, $name: String!) {
project(name: $project, entityName: $entity) {
sweep(sweepName: $name) {
id
name
state
bestLoss
config
}
}
}
"""
)
def __init__(self, client, entity, project, sweep_id, attrs=None):
# TODO: Add agents / flesh this out.
super().__init__(dict(attrs or {}))
self.client = client
self._entity = entity
self.project = project
self.id = sweep_id
self.runs = []
self.load(force=not attrs)
@property
def entity(self):
return self._entity
@property
def username(self):
wandb.termwarn("Sweep.username is deprecated. please use Sweep.entity instead.")
return self._entity
@property
def config(self):
return util.load_yaml(self._attrs["config"])
def load(self, force: bool = False):
if force or not self._attrs:
sweep = self.get(self.client, self.entity, self.project, self.id)
if sweep is None:
raise ValueError("Could not find sweep {}".format(self))
self._attrs = sweep._attrs
self.runs = sweep.runs
return self._attrs
@property
def order(self):
if self._attrs.get("config") and self.config.get("metric"):
sort_order = self.config["metric"].get("goal", "minimize")
prefix = "+" if sort_order == "minimize" else "-"
return public.QueryGenerator.format_order_key(
prefix + self.config["metric"]["name"]
)
def best_run(self, order=None):
"""Return the best run sorted by the metric defined in config or the order passed in."""
if order is None:
order = self.order
else:
order = public.QueryGenerator.format_order_key(order)
if order is None:
wandb.termwarn(
"No order specified and couldn't find metric in sweep config, returning most recent run"
)
else:
wandb.termlog("Sorting runs by {}".format(order))
filters = {"$and": [{"sweep": self.id}]}
try:
return public.Runs(
self.client,
self.entity,
self.project,
order=order,
filters=filters,
per_page=1,
)[0]
except IndexError:
return None
@property
def expected_run_count(self) -> Optional[int]:
"""Return the number of expected runs in the sweep or None for infinite runs."""
return self._attrs.get("runCountExpected")
@property
def path(self):
return [
urllib.parse.quote_plus(str(self.entity)),
urllib.parse.quote_plus(str(self.project)),
urllib.parse.quote_plus(str(self.id)),
]
@property
def url(self):
path = self.path
path.insert(2, "sweeps")
return self.client.app_url + "/".join(path)
@property
def name(self):
return self.config.get("name") or self.id
@classmethod
def get(
cls,
client,
entity=None,
project=None,
sid=None,
order=None,
query=None,
**kwargs,
):
"""Execute a query against the cloud backend."""
if query is None:
query = cls.QUERY
variables = {
"entity": entity,
"project": project,
"name": sid,
}
variables.update(kwargs)
response = None
try:
response = client.execute(query, variable_values=variables)
except Exception:
# Don't handle exception, rely on legacy query
# TODO(gst): Implement updated introspection workaround
query = cls.LEGACY_QUERY
response = client.execute(query, variable_values=variables)
if (
not response
or not response.get("project")
or not response["project"].get("sweep")
):
return None
sweep_response = response["project"]["sweep"]
sweep = cls(client, entity, project, sid, attrs=sweep_response)
sweep.runs = public.Runs(
client,
entity,
project,
order=order,
per_page=10,
filters={"$and": [{"sweep": sweep.id}]},
)
return sweep
def to_html(self, height=420, hidden=False):
"""Generate HTML containing an iframe displaying this sweep."""
url = self.url + "?jupyter=true"
style = f"border:none;width:100%;height:{height}px;"
prefix = ""
if hidden:
style += "display:none;"
prefix = ipython.toggle_button("sweep")
return prefix + f"<iframe src={url!r} style={style!r}></iframe>"
def _repr_html_(self) -> str:
return self.to_html()
def __repr__(self):
return "<Sweep {} ({})>".format(
"/".join(self.path), self._attrs.get("state", "Unknown State")
)
|