lightly-studio 0.4.6__py3-none-any.whl

lightly_studio/export_schema.py

@@ -0,0 +1,18 @@
+"""Export OpenAPI schema from FastAPI application to JSON file."""
+
+import argparse
+import json
+
+from lightly_studio.api.app import app
+
+parser = argparse.ArgumentParser(description="Export OpenAPI schema to a file.")
+parser.add_argument(
+    "--output",
+    type=str,
+    default="openapi.json",
+    help="The output file path for the OpenAPI schema (default: openapi.json).",
+)
+args = parser.parse_args()
+
+with open(args.output, "w") as f:
+    json.dump(app.openapi(), f, indent=2)

lightly_studio/export_version.py

@@ -0,0 +1,57 @@
+"""Export LightlyStudio version information to JSON file."""
+
+import argparse
+import json
+import subprocess
+from importlib import metadata
+from typing import TypedDict
+
+
+class VersionInfo(TypedDict):
+    """Version information of LightlyStudio."""
+
+    version: str
+    """Version from package metadata."""
+
+    git_sha: str
+    """Git SHA of the current commit."""
+
+    is_tagged_commit: bool
+    """Whether the current commit is tagged with vX.Y.Z where X.Y.Z is the version."""
+
+    _comment: str
+    """Documentation comment."""
+
+
+def get_version_info() -> VersionInfo:
+    """Retrieve version information of LightlyStudio."""
+    version = metadata.version("lightly-studio")
+    git_sha = subprocess.check_output(["git", "rev-parse", "--short", "HEAD"], text=True).strip()
+    tag = f"v{version}"
+    try:
+        tag_sha = subprocess.check_output(["git", "rev-parse", "--short", tag], text=True).strip()
+    except subprocess.CalledProcessError:
+        tag_sha = ""
+
+    return VersionInfo(
+        version=version,
+        git_sha=git_sha,
+        is_tagged_commit=(tag_sha == git_sha),
+        _comment="Autogenerated by export_version.py. Do not edit manually.",
+    )
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Export LightlyStudio version to a file.")
+    parser.add_argument(
+        "--output",
+        type=str,
+        default="version.json",
+        help="The output file path for the OpenAPI schema (default: openapi.json).",
+    )
+    args = parser.parse_args()
+
+    version_info = get_version_info()
+    print(version_info)
+    with open(args.output, "w") as f:
+        json.dump(version_info, f, indent=2)

lightly_studio/few_shot_classifier/classifier.py

@@ -0,0 +1,80 @@
+"""FewShotClassifier Protocol."""
+
+from __future__ import annotations
+
+import io
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Literal, Protocol, runtime_checkable
+
+ExportType = Literal["sklearn", "lightly"]
+
+
+@dataclass
+class AnnotatedEmbedding:
+    """Annotated embedding class.
+
+    Attributes:
+        embedding: The embedding vector as a list of floats.
+        annotation: The annotation for the embedding.
+                    Note: Currently it is an string but it can be a integer or
+                    any other type.
+    """
+
+    embedding: list[float]
+    annotation: str
+
+
+@runtime_checkable
+class FewShotClassifier(Protocol):
+    """Protocol defining the interface for classifiers."""
+
+    def train(self, annotated_embeddings: list[AnnotatedEmbedding]) -> None:
+        """Trains a classifier using the provided input.
+
+        Args:
+            annotated_embeddings: A list of annotated embeddings to train the
+            classifier.
+
+        Raises:
+            ValueError: If annotated_embeddings is empty or contains invalid
+            classes.
+        """
+        ...
+
+    def predict(self, embeddings: list[list[float]]) -> list[list[float]]:
+        """Predicts the classification scores for a list of embeddings.
+
+        Args:
+            embeddings: A list of embeddings, where each embedding is a list of
+            floats.
+
+        Returns:
+            A list of lists, where each inner list represents the probability
+            distribution over classes for the corresponding input embedding.
+            Each value in the inner list corresponds to the likelihood of the
+            embedding belonging to a specific class.
+            If embeddings is empty, returns an empty list.
+        """
+        ...
+
+    def export(
+        self,
+        export_path: Path | None,
+        buffer: io.BytesIO | None,
+        export_type: ExportType,
+    ) -> None:
+        """Exports the classifier to a specified file.
+
+        This method saves the trained classifier to the given file path so that
+        it can be reused or shared.
+
+        Args:
+            export_path: The path to the file where the classifier should
+            be saved.
+            buffer: An optional in-memory buffer to write the exported
+            classifier to.
+            export_type: The type of export format to use. This can be either
+            "sklearn_instance" or "raw".
+        """
+        ...