File size: 5,475 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 |
"""Public API: projects."""
from contextlib import suppress
from requests import HTTPError
from wandb_gql import gql
from wandb.apis import public
from wandb.apis.attrs import Attrs
from wandb.apis.normalize import normalize_exceptions
from wandb.apis.paginator import Paginator
from wandb.sdk.lib import ipython
PROJECT_FRAGMENT = """fragment ProjectFragment on Project {
id
name
entityName
createdAt
isBenchmark
}"""
class Projects(Paginator["Project"]):
"""An iterable collection of `Project` objects."""
QUERY = gql(
"""
query Projects($entity: String, $cursor: String, $perPage: Int = 50) {{
models(entityName: $entity, after: $cursor, first: $perPage) {{
edges {{
node {{
...ProjectFragment
}}
cursor
}}
pageInfo {{
endCursor
hasNextPage
}}
}}
}}
{}
""".format(PROJECT_FRAGMENT)
)
def __init__(self, client, entity, per_page=50):
self.client = client
self.entity = entity
variables = {
"entity": self.entity,
}
super().__init__(client, variables, per_page)
@property
def length(self) -> None:
# For backwards compatibility, even though this isn't a SizedPaginator
return None
@property
def more(self):
if self.last_response:
return self.last_response["models"]["pageInfo"]["hasNextPage"]
else:
return True
@property
def cursor(self):
if self.last_response:
return self.last_response["models"]["edges"][-1]["cursor"]
else:
return None
def convert_objects(self):
return [
Project(self.client, self.entity, p["node"]["name"], p["node"])
for p in self.last_response["models"]["edges"]
]
def __repr__(self):
return f"<Projects {self.entity}>"
class Project(Attrs):
"""A project is a namespace for runs."""
def __init__(self, client, entity, project, attrs):
super().__init__(dict(attrs))
self.client = client
self.name = project
self.entity = entity
@property
def path(self):
return [self.entity, self.name]
@property
def url(self):
return self.client.app_url + "/".join(self.path + ["workspace"])
def to_html(self, height=420, hidden=False):
"""Generate HTML containing an iframe displaying this project."""
url = self.url + "?jupyter=true"
style = f"border:none;width:100%;height:{height}px;"
prefix = ""
if hidden:
style += "display:none;"
prefix = ipython.toggle_button("project")
return prefix + f"<iframe src={url!r} style={style!r}></iframe>"
def _repr_html_(self) -> str:
return self.to_html()
def __repr__(self):
return "<Project {}>".format("/".join(self.path))
@normalize_exceptions
def artifacts_types(self, per_page=50):
return public.ArtifactTypes(self.client, self.entity, self.name)
@normalize_exceptions
def sweeps(self):
query = gql(
"""
query GetSweeps($project: String!, $entity: String!) {{
project(name: $project, entityName: $entity) {{
totalSweeps
sweeps {{
edges {{
node {{
...SweepFragment
}}
cursor
}}
pageInfo {{
endCursor
hasNextPage
}}
}}
}}
}}
{}
""".format(public.SWEEP_FRAGMENT)
)
variable_values = {"project": self.name, "entity": self.entity}
ret = self.client.execute(query, variable_values)
if ret["project"]["totalSweeps"] < 1:
return []
return [
# match format of existing public sweep apis
public.Sweep(
self.client,
self.entity,
self.name,
e["node"]["name"],
)
for e in ret["project"]["sweeps"]["edges"]
]
_PROJECT_ID = gql(
"""
query ProjectID($projectName: String!, $entityName: String!) {
project(name: $projectName, entityName: $entityName) {
id
}
}
"""
)
@property
def id(self) -> str:
# This is a workaround to ensure that the project ID can be retrieved
# on demand, as it generally is not set or fetched on instantiation.
# This is necessary if using this project as the scope of a new Automation.
with suppress(LookupError):
return self._attrs["id"]
variable_values = {"projectName": self.name, "entityName": self.entity}
try:
data = self.client.execute(self._PROJECT_ID, variable_values)
self._attrs["id"] = data["project"]["id"]
return self._attrs["id"]
except (HTTPError, LookupError, TypeError) as e:
raise ValueError(f"Unable to fetch project ID: {variable_values!r}") from e
|