File size: 15,302 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 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 |
"""Public API: reports."""
import ast
import json
import urllib
from wandb_gql import gql
import wandb
from wandb.apis import public
from wandb.apis.attrs import Attrs
from wandb.apis.paginator import SizedPaginator
from wandb.sdk.lib import ipython
class Reports(SizedPaginator["BetaReport"]):
"""Reports is an iterable collection of `BetaReport` objects."""
QUERY = gql(
"""
query ProjectViews($project: String!, $entity: String!, $reportCursor: String,
$reportLimit: Int!, $viewType: String = "runs", $viewName: String) {
project(name: $project, entityName: $entity) {
allViews(viewType: $viewType, viewName: $viewName, first:
$reportLimit, after: $reportCursor) {
edges {
node {
id
name
displayName
description
user {
username
photoUrl
}
spec
updatedAt
}
cursor
}
pageInfo {
endCursor
hasNextPage
}
}
}
}
"""
)
def __init__(self, client, project, name=None, entity=None, per_page=50):
self.project = project
self.name = name
variables = {
"project": project.name,
"entity": project.entity,
"viewName": self.name,
}
super().__init__(client, variables, per_page)
@property
def length(self):
# TODO: Add the count the backend
if self.last_response:
return len(self.objects)
else:
return None
@property
def more(self):
if self.last_response:
return self.last_response["project"]["allViews"]["pageInfo"]["hasNextPage"]
else:
return True
@property
def cursor(self):
if self.last_response:
return self.last_response["project"]["allViews"]["edges"][-1]["cursor"]
else:
return None
def update_variables(self):
self.variables.update(
{"reportCursor": self.cursor, "reportLimit": self.per_page}
)
def convert_objects(self):
if self.last_response["project"] is None:
raise ValueError(
f"Project {self.variables['project']} does not exist under entity {self.variables['entity']}"
)
return [
BetaReport(
self.client,
r["node"],
entity=self.project.entity,
project=self.project.name,
)
for r in self.last_response["project"]["allViews"]["edges"]
]
def __repr__(self):
return "<Reports {}>".format("/".join(self.project.path))
class BetaReport(Attrs):
"""BetaReport is a class associated with reports created in wandb.
WARNING: this API will likely change in a future release
Attributes:
name (string): report name
description (string): report description;
user (User): the user that created the report
spec (dict): the spec off the report;
updated_at (string): timestamp of last update
"""
def __init__(self, client, attrs, entity=None, project=None):
self.client = client
self.project = project
self.entity = entity
self.query_generator = public.QueryGenerator()
super().__init__(dict(attrs))
self._attrs["spec"] = json.loads(self._attrs["spec"])
@property
def sections(self):
return self.spec["panelGroups"]
def runs(self, section, per_page=50, only_selected=True):
run_set_idx = section.get("openRunSet", 0)
run_set = section["runSets"][run_set_idx]
order = self.query_generator.key_to_server_path(run_set["sort"]["key"])
if run_set["sort"].get("ascending"):
order = "+" + order
else:
order = "-" + order
filters = self.query_generator.filter_to_mongo(run_set["filters"])
if only_selected:
# TODO: handle this not always existing
filters["$or"][0]["$and"].append(
{"name": {"$in": run_set["selections"]["tree"]}}
)
return public.Runs(
self.client,
self.entity,
self.project,
filters=filters,
order=order,
per_page=per_page,
)
@property
def updated_at(self):
return self._attrs["updatedAt"]
@property
def url(self):
return self.client.app_url + "/".join(
[
self.entity,
self.project,
"reports",
"--".join(
[
urllib.parse.quote(self.display_name.replace(" ", "-")),
self.id.replace("=", ""),
]
),
]
)
def to_html(self, height=1024, hidden=False):
"""Generate HTML containing an iframe displaying this report."""
url = self.url + "?jupyter=true"
style = f"border:none;width:100%;height:{height}px;"
prefix = ""
if hidden:
style += "display:none;"
prefix = ipython.toggle_button("report")
return prefix + f"<iframe src={url!r} style={style!r}></iframe>"
def _repr_html_(self) -> str:
return self.to_html()
class PythonMongoishQueryGenerator:
SPACER = "----------"
DECIMAL_SPACER = ";;;"
FRONTEND_NAME_MAPPING = {
"ID": "name",
"Name": "displayName",
"Tags": "tags",
"State": "state",
"CreatedTimestamp": "createdAt",
"Runtime": "duration",
"User": "username",
"Sweep": "sweep",
"Group": "group",
"JobType": "jobType",
"Hostname": "host",
"UsingArtifact": "inputArtifacts",
"OutputtingArtifact": "outputArtifacts",
"Step": "_step",
"Relative Time (Wall)": "_absolute_runtime",
"Relative Time (Process)": "_runtime",
"Wall Time": "_timestamp",
# "GroupedRuns": "__wb_group_by_all"
}
FRONTEND_NAME_MAPPING_REVERSED = {v: k for k, v in FRONTEND_NAME_MAPPING.items()}
AST_OPERATORS = {
ast.Lt: "$lt",
ast.LtE: "$lte",
ast.Gt: "$gt",
ast.GtE: "$gte",
ast.Eq: "=",
ast.Is: "=",
ast.NotEq: "$ne",
ast.IsNot: "$ne",
ast.In: "$in",
ast.NotIn: "$nin",
ast.And: "$and",
ast.Or: "$or",
ast.Not: "$not",
}
AST_FIELDS = {
ast.Constant: "value",
ast.Name: "id",
ast.List: "elts",
ast.Tuple: "elts",
}
def __init__(self, run_set):
self.run_set = run_set
self.panel_metrics_helper = PanelMetricsHelper()
def _handle_compare(self, node):
# only left side can be a col
left = self.front_to_back(self._handle_fields(node.left))
op = self._handle_ops(node.ops[0])
right = self._handle_fields(node.comparators[0])
# Eq has no op for some reason
if op == "=":
return {left: right}
else:
return {left: {op: right}}
def _handle_fields(self, node):
result = getattr(node, self.AST_FIELDS.get(type(node)))
if isinstance(result, list):
return [self._handle_fields(node) for node in result]
elif isinstance(result, str):
return self._unconvert(result)
return result
def _handle_ops(self, node):
return self.AST_OPERATORS.get(type(node))
def _replace_numeric_dots(self, s):
numeric_dots = []
for i, (left, mid, right) in enumerate(zip(s, s[1:], s[2:]), 1):
if mid == ".":
if (
left.isdigit()
and right.isdigit() # 1.2
or left.isdigit()
and right == " " # 1.
or left == " "
and right.isdigit() # .2
):
numeric_dots.append(i)
# Edge: Catch number ending in dot at end of string
if s[-2].isdigit() and s[-1] == ".":
numeric_dots.append(len(s) - 1)
numeric_dots = [-1] + numeric_dots + [len(s)]
substrs = []
for start, stop in zip(numeric_dots, numeric_dots[1:]):
substrs.append(s[start + 1 : stop])
substrs.append(self.DECIMAL_SPACER)
substrs = substrs[:-1]
return "".join(substrs)
def _convert(self, filterstr):
_conversion = (
self._replace_numeric_dots(filterstr) # temporarily sub numeric dots
.replace(".", self.SPACER) # Allow dotted fields
.replace(self.DECIMAL_SPACER, ".") # add them back
)
return "(" + _conversion + ")"
def _unconvert(self, field_name):
return field_name.replace(self.SPACER, ".") # Allow dotted fields
def python_to_mongo(self, filterstr):
try:
tree = ast.parse(self._convert(filterstr), mode="eval")
except SyntaxError as e:
raise ValueError(
"Invalid python comparison expression; form something like `my_col == 123`"
) from e
multiple_filters = hasattr(tree.body, "op")
if multiple_filters:
op = self.AST_OPERATORS.get(type(tree.body.op))
values = [self._handle_compare(v) for v in tree.body.values]
else:
op = "$and"
values = [self._handle_compare(tree.body)]
return {"$or": [{op: values}]}
def front_to_back(self, name):
name, *rest = name.split(".")
rest = "." + ".".join(rest) if rest else ""
if name in self.FRONTEND_NAME_MAPPING:
return self.FRONTEND_NAME_MAPPING[name]
elif name in self.FRONTEND_NAME_MAPPING_REVERSED:
return name
elif name in self.run_set._runs_config:
return f"config.{name}.value{rest}"
else: # assume summary metrics
return f"summary_metrics.{name}{rest}"
def back_to_front(self, name):
if name in self.FRONTEND_NAME_MAPPING_REVERSED:
return self.FRONTEND_NAME_MAPPING_REVERSED[name]
elif name in self.FRONTEND_NAME_MAPPING:
return name
elif (
name.startswith("config.") and ".value" in name
): # may be brittle: originally "endswith", but that doesn't work with nested keys...
# strip is weird sometimes (??)
return name.replace("config.", "").replace(".value", "")
elif name.startswith("summary_metrics."):
return name.replace("summary_metrics.", "")
wandb.termerror(f"Unknown token: {name}")
return name
# These are only used for ParallelCoordinatesPlot because it has weird backend names...
def pc_front_to_back(self, name):
name, *rest = name.split(".")
rest = "." + ".".join(rest) if rest else ""
if name is None:
return None
elif name in self.panel_metrics_helper.FRONTEND_NAME_MAPPING:
return "summary:" + self.panel_metrics_helper.FRONTEND_NAME_MAPPING[name]
elif name in self.FRONTEND_NAME_MAPPING:
return self.FRONTEND_NAME_MAPPING[name]
elif name in self.FRONTEND_NAME_MAPPING_REVERSED:
return name
elif name in self.run_set._runs_config:
return f"config:{name}.value{rest}"
else: # assume summary metrics
return f"summary:{name}{rest}"
def pc_back_to_front(self, name):
if name is None:
return None
elif "summary:" in name:
name = name.replace("summary:", "")
return self.panel_metrics_helper.FRONTEND_NAME_MAPPING_REVERSED.get(
name, name
)
elif name in self.FRONTEND_NAME_MAPPING_REVERSED:
return self.FRONTEND_NAME_MAPPING_REVERSED[name]
elif name in self.FRONTEND_NAME_MAPPING:
return name
elif name.startswith("config:") and ".value" in name:
return name.replace("config:", "").replace(".value", "")
elif name.startswith("summary_metrics."):
return name.replace("summary_metrics.", "")
return name
class PanelMetricsHelper:
FRONTEND_NAME_MAPPING = {
"Step": "_step",
"Relative Time (Wall)": "_absolute_runtime",
"Relative Time (Process)": "_runtime",
"Wall Time": "_timestamp",
}
FRONTEND_NAME_MAPPING_REVERSED = {v: k for k, v in FRONTEND_NAME_MAPPING.items()}
RUN_MAPPING = {"Created Timestamp": "createdAt", "Latest Timestamp": "heartbeatAt"}
RUN_MAPPING_REVERSED = {v: k for k, v in RUN_MAPPING.items()}
def front_to_back(self, name):
if name in self.FRONTEND_NAME_MAPPING:
return self.FRONTEND_NAME_MAPPING[name]
return name
def back_to_front(self, name):
if name in self.FRONTEND_NAME_MAPPING_REVERSED:
return self.FRONTEND_NAME_MAPPING_REVERSED[name]
return name
# ScatterPlot and ParallelCoords have weird conventions
def special_front_to_back(self, name):
if name is None:
return name
name, *rest = name.split(".")
rest = "." + ".".join(rest) if rest else ""
# special case for config
if name.startswith("c::"):
name = name[3:]
return f"config:{name}.value{rest}"
# special case for summary
if name.startswith("s::"):
name = name[3:] + rest
return f"summary:{name}"
name = name + rest
if name in self.RUN_MAPPING:
return "run:" + self.RUN_MAPPING[name]
if name in self.FRONTEND_NAME_MAPPING:
return "summary:" + self.FRONTEND_NAME_MAPPING[name]
if name == "Index":
return name
return "summary:" + name
def special_back_to_front(self, name):
if name is not None:
kind, rest = name.split(":", 1)
if kind == "config":
pieces = rest.split(".")
if len(pieces) <= 1:
raise ValueError(f"Invalid name: {name}")
elif len(pieces) == 2:
name = pieces[0]
elif len(pieces) >= 3:
name = pieces[:1] + pieces[2:]
name = ".".join(name)
return f"c::{name}"
elif kind == "summary":
name = rest
return f"s::{name}"
if name is None:
return name
elif "summary:" in name:
name = name.replace("summary:", "")
return self.FRONTEND_NAME_MAPPING_REVERSED.get(name, name)
elif "run:" in name:
name = name.replace("run:", "")
return self.RUN_MAPPING_REVERSED[name]
return name
|