wandb 0.13.10__py3-none-any.whl → 0.14.0__py3-none-any.whl

wandb/apis/reports/_templates.py

@@ -4,9 +4,7 @@ from .util import coalesce
 
 
 def create_example_header():
-    """
-    Creates an example header with image at top.
-    """
+    """Create an example header with image at top."""
     import wandb.apis.reports as wr
 
     return [
@@ -23,9 +21,7 @@ def create_example_header():
 
 
 def create_example_footer():
-    """
-    Creates an example footer with image and text at bottom.
-    """
+    """Create an example footer with image and text at bottom."""
     import wandb.apis.reports as wr
 
     return [
@@ -49,9 +45,9 @@ def create_enterprise_report(
     body=None,
     footer=None,
 ):
-    """
-    Creates an example enterprise report with a header and footer which
-    can be used to add custom branding to reports.
+    """Create an example enterprise report with a header and footer.
+
+    Can be used to add custom branding to reports.
     """
     import wandb.apis.reports as wr
 
@@ -74,9 +70,7 @@ def create_customer_landing_page(
     main_contact="My Contact (name@email.com)",
     slack_link="https://company.slack.com",
 ):
-    """
-    Creates an example customer landing page using data from Andrew's demo.
-    """
+    """Create an example customer landing page using data from Andrew's demo."""
     import wandb.apis.reports as wr
 
     project = coalesce(project, "default-project")

wandb/apis/reports/report.py

@@ -220,7 +220,7 @@ class Report(Base):
             return self
 
     def to_html(self, height: int = 1024, hidden: bool = False) -> str:
-        """Generate HTML containing an iframe displaying this report"""
+        """Generate HTML containing an iframe displaying this report."""
         try:
             url = self.url + "?jupyter=true"
             style = f"border:none;width:100%;height:{height}px;"

wandb/apis/reports/runset.py

@@ -43,9 +43,7 @@ class Runset(Base):
 
     @classmethod
     def from_json(cls, spec: Dict[str, Any]) -> T:
-        """
-        This has a custom implementation because sometimes runsets are missing the project field.
-        """
+        """This has a custom implementation because sometimes runsets are missing the project field."""
         obj = cls()
         obj._spec = spec
 

wandb/apis/reports/util.py

@@ -22,10 +22,10 @@ Func = Callable[[T], V]
 
 
 def generate_name(length: int = 12) -> str:
-    """
-    Generate random name.
+    """Generate a random name.
+
     This implementation roughly based the following snippet in core:
-    https://github.com/wandb/core/blob/master/lib/js/cg/src/utils/string.ts#L39-L44
+    https://github.com/wandb/core/blob/master/lib/js/cg/src/utils/string.ts#L39-L44.
     """
 
     # Borrowed from numpy: https://github.com/numpy/numpy/blob/v1.23.0/numpy/core/numeric.py#L2069-L2123
@@ -54,14 +54,17 @@ def generate_name(length: int = 12) -> str:
 
 
 def coalesce(*arg: Any) -> Any:
-    """Return the first non-none value in the list of arguments.  Similar to ?? in C#"""
+    """Return the first non-none value in the list of arguments.
+
+    Similar to ?? in C#.
+    """
     return next((a for a in arg if a is not None), None)
 
 
 def nested_get(json: dict, keys: str) -> Any:
-    """
-    Given a nested JSON dict and path, get the element at the terminal node.
-    The first item of the path can be an object
+    """Get the element at the terminal node of a nested JSON dict based on `path`.
+
+    The first item of the path can be an object.
     """
     keys = keys.split(".")
     if len(keys) == 1:
@@ -81,8 +84,8 @@ def nested_get(json: dict, keys: str) -> Any:
 
 
 def nested_set(json: dict, keys: str, value: Any) -> None:
-    """
-    Given a nested JSON dict and path, set the element at the terminal node.
+    """Set the element at the terminal node of a nested JSON dict based on `path`.
+
     The first item of the path can be an object.
 
     If nodes do not exist, they are created along the way.
@@ -323,7 +326,6 @@ def fix_collisions(panels: List[Panel]) -> List[Panel]:
     for i, p1 in enumerate(panels):
         for p2 in panels[i:]:
             if collides(p1, p2):
-
                 # try to move right
                 x, y = shift(p1, p2)
                 if p2.layout["x"] + p2.layout["w"] + x <= x_max:

wandb/beta/workflows.py

@@ -16,15 +16,17 @@ def _add_any(
     ],  # todo: add dataframe
     name: Optional[str],
 ) -> Any:
-    """High-level wrapper to add object(s) to an artifact - calls any of the .add* methods
-    under Artifact depending on the type of object that's passed in. This will probably be moved
-    to the Artifact class in the future.
+    """Add an object to an artifact.
 
-    Args:
-        artifact: `ArtifactInterface` - most likely a LocalArtifact created with `wandb.Artifact(...)`
+    High-level wrapper to add object(s) to an artifact - calls any of the .add* methods
+    under Artifact depending on the type of object that's passed in. This will probably
+    be moved to the Artifact class in the future.
 
-        path_or_obj: `Union[str, ArtifactManifestEntry, data_types.WBValue]` - either a str or valid object which
-        indicates what to add to an artifact.
+    Args:
+        artifact: `ArtifactInterface` - most likely a LocalArtifact created with
+            `wandb.Artifact(...)`
+        path_or_obj: `Union[str, ArtifactManifestEntry, data_types.WBValue]` - either a
+            str or valid object which indicates what to add to an artifact.
 
         name: `str` - the name of the object which is added to an artifact.
 
@@ -61,15 +63,20 @@ def _log_artifact_version(
     scope_project: Optional[bool] = None,
     job_type: str = "auto",
 ) -> ArtifactInterface:
-    """Creates an artifact, populates it, and logs it with a run.
+    """Create an artifact, populate it, and log it with a run.
+
     If a run is not present, we create one.
 
     Args:
-        name: `str` - name of the artifact. If not scoped to a project, name will be suffixed by "-{run_id}".
-        type: `str` - type of the artifact, used in the UI to group artifacts of the same type.
-        entries: `Dict` - dictionary containing the named objects we want added to this artifact.
+        name: `str` - name of the artifact. If not scoped to a project, name will be
+            suffixed by "-{run_id}".
+        type: `str` - type of the artifact, used in the UI to group artifacts of the
+            same type.
+        entries: `Dict` - dictionary containing the named objects we want added to this
+            artifact.
         description: `str` - text description of artifact.
-        metadata: `Dict` - users can pass in artifact-specific metadata here, will be visible in the UI.
+        metadata: `Dict` - users can pass in artifact-specific metadata here, will be
+            visible in the UI.
         project: `str` - project under which to place this artifact.
         scope_project: `bool` - if True, we will not suffix `name` with "-{run_id}".
         job_type: `str` - Only applied if run is not present and we create one.
@@ -114,28 +121,35 @@ def log_model(
     scope_project: Optional[bool] = None,
     **kwargs: Dict[str, Any],
 ) -> "_SavedModel":
-    """Logs a model object to enable model-centric workflows in the UI.
-    Supported frameworks include PyTorch, Keras, Tensorflow, Scikit-learn, etc.
-    Under the hood, we create a model artifact, bind it to the run that produced this model,
+    """Log a model object to enable model-centric workflows in the UI.
+
+    Supported frameworks include PyTorch, Keras, Tensorflow, Scikit-learn, etc. Under
+    the hood, we create a model artifact, bind it to the run that produced this model,
     associate it with the latest metrics logged with `wandb.log(...)` and more.
 
     Args:
-        model_obj: any model object created with the following ML frameworks: PyTorch, Keras, Tensorflow, Scikit-learn.
-        name: `str` - name of the model artifact that will be created to house this model_obj.
-        aliases: `str, List[str]` - optional alias(es) that will be applied on this model and allow for unique
-            identification. The alias "latest" will always be applied to the latest version of a model.
-        description: `str` - text description/notes about the model - will be visible in the Model Card UI.
+        model_obj: any model object created with the following ML frameworks: PyTorch,
+            Keras, Tensorflow, Scikit-learn. name: `str` - name of the model artifact
+            that will be created to house this model_obj.
+        aliases: `str, List[str]` - optional alias(es) that will be applied on this
+            model and allow for unique identification. The alias "latest" will always be
+            applied to the latest version of a model.
+        description: `str` - text description/notes about the model - will be visible in
+            the Model Card UI.
         metadata: `Dict` - model-specific metadata goes here - will be visible the UI.
         project: `str` - project under which to place this artifact.
-        scope_project: `bool` - If true, name of this model artifact will not be suffixed by `-{run_id}`.
+        scope_project: `bool` - If true, name of this model artifact will not be
+            suffixed by `-{run_id}`.
 
     Returns:
         _SavedModel instance
 
     Example:
+        ```python
         import torch.nn as nn
         import torch.nn.functional as F
 
+
         class Net(nn.Module):
             def __init__(self):
                 super(Net, self).__init__()
@@ -146,8 +160,10 @@ def log_model(
                 x = F.relu(x)
                 return x
 
+
         model = Net()
         sm = log_model(model, "my-simple-model", aliases=["best"])
+        ```
 
     """
     model = data_types._SavedModel.init(model_obj, **kwargs)
@@ -169,21 +185,25 @@ def log_model(
 
 
 def use_model(aliased_path: str) -> "_SavedModel":
-    """Allows the user to fetch their saved model with an alias.
-    Under the hood, we use the alias to fetch the model artifact containing the serialized model files
-    and rebuild the model object from these files. We also declare the fetched model artifact as an
-    input to the run (with `run.use_artifact`).
+    """Fetch a saved model from an alias.
+
+    Under the hood, we use the alias to fetch the model artifact containing the
+    serialized model files and rebuild the model object from these files. We also
+    declare the fetched model artifact as an input to the run (with `run.use_artifact`).
 
     Args:
-        aliased_path: `str` - the following forms are valid: "name:version", "name:alias". May be prefixed with "entity/project".
+        aliased_path: `str` - the following forms are valid: "name:version",
+            "name:alias". May be prefixed with "entity/project".
 
     Returns:
         _SavedModel instance
 
     Example:
-        # assuming you have previously logged a model with the name "my-simple-model"
+        ```python
+        # Assuming you have previously logged a model with the name "my-simple-model":
         sm = use_model("my-simple-model:latest")
         model = sm.model_obj()
+        ```
     """
     if ":" not in aliased_path:
         raise ValueError(
@@ -213,15 +233,19 @@ def link_model(
     target_path: str,
     aliases: Optional[Union[str, List[str]]] = None,
 ) -> None:
-    """Links the given model to a portfolio (a promoted collection which contains, in this case, model artifacts).
+    """Link the given model to a portfolio.
+
+    A portfolio is a promoted collection which contains (in this case) model artifacts.
     Linking to a portfolio allows for useful model-centric workflows in the UI.
 
     Args:
-        model: `_SavedModel` - an instance of _SavedModel, most likely from the output of `log_model` or `use_model`.
-        target_path: `str` - the target portfolio. The following forms are valid for the string: {portfolio}, {project/portfolio},
-            {entity}/{project}/{portfolio}.
-        aliases: `str, List[str]` - optional alias(es) that will only be applied on this linked model inside the portfolio.
-            The alias "latest" will always be applied to the latest version of a model.
+        model: `_SavedModel` - an instance of _SavedModel, most likely from the output
+            of `log_model` or `use_model`.
+        target_path: `str` - the target portfolio. The following forms are valid for the
+            string: {portfolio}, {project/portfolio},{entity}/{project}/{portfolio}.
+        aliases: `str, List[str]` - optional alias(es) that will only be applied on this
+            linked model inside the portfolio. The alias "latest" will always be applied
+            to the latest version of a model.
 
     Returns:
         None
@@ -231,7 +255,6 @@ def link_model(
         link_model(sm, "my-portfolio")
 
     """
-
     aliases = wandb.util._resolve_aliases(aliases)
 
     if wandb.run:

wandb/catboost/__init__.py

@@ -1,5 +1,4 @@
-"""
-Compatibility catboost module.
+"""Compatibility catboost module.
 
 In the future use:
     from wandb.integration.catboost import WandbCallback