truss 0.10.0rc1__py3-none-any.whl → 0.60.0__py3-none-any.whl

truss_chains/utils.py

@@ -0,0 +1,178 @@
+import contextlib
+import enum
+import inspect
+import logging
+import os
+import random
+import socket
+from typing import Any, Iterable, Iterator, TypeVar, Union
+
+from truss_chains import definitions
+
+T = TypeVar("T")
+
+
+def make_abs_path_here(file_path: str) -> definitions.AbsPath:
+    """Helper to specify file paths relative to the *immediately calling* module.
+
+    E.g. in you have a project structure like this::
+
+        root/
+            chain.py
+            common_requirements.text
+            sub_package/
+                chainlet.py
+                chainlet_requirements.txt
+
+    You can now in ``root/sub_package/chainlet.py`` point to the requirements
+    file like this::
+
+        shared = make_abs_path_here("../common_requirements.text")
+        specific = make_abs_path_here("chainlet_requirements.text")
+
+
+    Warning:
+        This helper uses the directory of the immediately calling module as an
+        absolute reference point for resolving the file location. Therefore,
+        you MUST NOT wrap the instantiation of ``make_abs_path_here`` into a
+        function (e.g. applying decorators) or use dynamic code execution.
+
+        Ok::
+
+            def foo(path: AbsPath):
+                abs_path = path.abs_path
+
+
+            foo(make_abs_path_here("./somewhere"))
+
+        Not Ok::
+
+            def foo(path: str):
+                dangerous_value = make_abs_path_here(path).abs_path
+
+
+            foo("./somewhere")
+
+    """
+    # TODO: the absolute path resolution below uses the calling module as a
+    #   reference point. This would not work if users wrap this call in a function
+    #   - we hope the naming makes clear that this should not be done.
+    caller_frame = inspect.stack()[1]
+    module_path = caller_frame.filename
+    if not os.path.isabs(file_path):
+        module_dir = os.path.dirname(os.path.abspath(module_path))
+        abs_file_path = os.path.normpath(os.path.join(module_dir, file_path))
+    else:
+        abs_file_path = file_path
+
+    return definitions.AbsPath(abs_file_path, module_path, file_path)
+
+
+def setup_dev_logging(level: Union[int, str] = logging.INFO) -> None:
+    root_logger = logging.getLogger()
+    root_logger.setLevel(level)
+    log_format = "%(levelname)s %(asctime)s %(filename)s:%(lineno)d] %(message)s"
+    date_format = "%m%d %H:%M:%S"
+    formatter = logging.Formatter(fmt=log_format, datefmt=date_format)
+    if root_logger.handlers:
+        for handler in root_logger.handlers:
+            handler.setFormatter(formatter)
+    else:
+        handler = logging.StreamHandler()
+        handler.setFormatter(formatter)
+        root_logger.addHandler(handler)
+
+
+@contextlib.contextmanager
+def log_level(level: int) -> Iterator[None]:
+    """Change loglevel for code in this context."""
+    current_logging_level = logging.getLogger().getEffectiveLevel()
+    logging.getLogger().setLevel(level)
+    try:
+        yield
+    finally:
+        logging.getLogger().setLevel(current_logging_level)
+
+
+def expect_one(it: Iterable[T]) -> T:
+    """Assert that an iterable has exactly on element and return it."""
+    it = iter(it)
+    try:
+        element = next(it)
+    except StopIteration:
+        raise ValueError("Iterable is empty.")
+
+    try:
+        _ = next(it)
+    except StopIteration:
+        return element
+
+    raise ValueError("Iterable has more than one element.")
+
+
+def get_free_port() -> int:
+    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
+        s.bind(("", 0))  # Bind to a free port provided by the host.
+        s.listen(1)  # Not necessary but included for completeness.
+        port = s.getsockname()[1]  # Retrieve the port number assigned.
+        return port
+
+
+########################################################################################
+
+
+class InjectedError(Exception):
+    """Test error for debugging/dev."""
+
+
+def random_fail(probability: float, msg: str):
+    """Probabilistically raises `InjectedError` for debugging/dev."""
+    if random.random() < probability:
+        print(f"Random failure: {msg}")
+        raise InjectedError(msg)
+
+
+class StrEnum(str, enum.Enum):
+    """
+    Adapted from MIT-licensed
+    https://github.com/irgeek/StrEnum/blob/master/strenum/__init__.py
+
+    This is useful for Pydantic-based (de-)serialisation, as Pydantic takes the value
+    of an enum member as the value to be (de-)serialised, and not the name of the
+    member. With this, we can have the member name and value be the same by using
+    `enum.auto()`.
+
+    StrEnum is a Python `enum.Enum` that inherits from `str`. The `auto()` behavior
+    uses the member name and lowers it. This is useful for compatibility with pydantic.
+    Example usage:
+
+    ```
+    class Example(StrEnum):
+        SOME_VALUE = enum.auto()
+        ANOTHER_VALUE = enum.auto()
+        TEST = enum.auto()
+
+    assert Example.SOME_VALUE == "SOME_VALUE"
+    assert Example.ANOTHER_VALUE.value == "ANOTHER_VALUE"
+    assert Example.TEST.value == Example.TEST
+    assert Example.TEST == Example("TEST")
+    ```
+    """
+
+    def __new__(cls, value, *args, **kwargs):
+        if not isinstance(value, str):
+            raise TypeError(f"Values of StrEnums must be strings: Got `{repr(value)}`.")
+        return super().__new__(cls, value, *args, **kwargs)
+
+    def __str__(self) -> str:
+        return str(self.value)
+
+    def _generate_next_value_(name, *_) -> str:  # type: ignore[override]
+        if name.upper() != name:
+            raise ValueError(f"Python enum members should be upper case. Got `{name}`.")
+        return name
+
+
+def issubclass_safe(x: Any, cls: type) -> bool:
+    """Like built-in `issubclass`, but works on non-type objects."""
+    return isinstance(x, type) and issubclass(x, cls)

CODE_OF_CONDUCT.md

@@ -1,131 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at support@baseten.co.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -1,48 +0,0 @@
-## Contributing
-
-Truss was first created at [Baseten](https://baseten.co), but as an open and living project eagerly accepts contributions of all kinds from the broader developer community. Please note that all participation with Truss falls under our [code of conduct](CODE_OF_CONDUCT.md).
-
-We use GitHub features for project management on Truss:
-
-* For bugs and feature requests, file an issue.
-* For changes and updates, create a pull request.
-* To view and comment on the roadmap, [check the projects tab](https://github.com/orgs/basetenlabs/projects/3).
-
-## Local development
-
-To get started contributing to the library, all you have to do is clone this repository!
-
-### Setup
-
-**PLEASE NOTE:** the ML ecosystem in general is still not well supported on M1 Macs, and as such, we do not recommend or support local development on M1 for Truss. Truss is well-optimized for use with GitHub Codespaces and other container-based development environments.
-
-We use `asdf` to manage Python binaries and `poetry` to manage Python dependencies.
-
-For development in a macOS environment, we use `brew` to manage system packages.
-
-```
-# Install asdf (or use another method https://asdf-vm.com/)
-brew install asdf
-
-# Install `asdf` managed python and poetry
-asdf plugin add python
-asdf plugin add poetry
-
-# Install poetry dependencies
-poetry install
-
-# And finally precommit
-poetry run pre-commit install
-```
-
-Then to run the entire test suite
-
-```
-poetry run pytest truss/tests
-```
-
-## Documentation
-
-To learn about Truss see the [official documentation](https://truss.baseten.co).
-
-Contributions to documentation are very welcome! Simply edit the appropriate markdown files in the `docs/` folder and make a pull request. For larger changes, tutorials, or any questions please contact [team@trussml.com](mailto:team@trussml.com).

README.md

@@ -1,137 +0,0 @@
-# Truss
-
-**The simplest way to serve AI/ML models in production**
-
-[![PyPI version](https://badge.fury.io/py/truss.svg)](https://badge.fury.io/py/truss)
-[![ci_status](https://github.com/basetenlabs/truss/actions/workflows/release.yml/badge.svg)](https://github.com/basetenlabs/truss/actions/workflows/release.yml)
-
-## Why Truss?
-
-* **Write once, run anywhere:** Package and test model code, weights, and dependencies with a model server that behaves the same in development and production.
-* **Fast developer loop:** Implement your model with fast feedback from a live reload server, and skip Docker and Kubernetes configuration with a batteries-included model serving environment.
-* **Support for all Python frameworks**: From `transformers` and `diffusers` to `PyTorch` and `TensorFlow` to `TensorRT` and `Triton`, Truss supports models created and served with any framework.
-
-See Trusses for popular models including:
-
-* 🦙 [Llama 2 7B](https://github.com/basetenlabs/truss-examples/tree/main/llama/llama-2-7b-chat) ([13B](https://github.com/basetenlabs/truss-examples/tree/main/llama/llama-2-13b-chat)) ([70B](https://github.com/basetenlabs/truss-examples/tree/main/llama/llama-2-70b-chat))
-* 🎨 [Stable Diffusion XL](https://github.com/basetenlabs/truss-examples/tree/main/stable-diffusion/stable-diffusion-xl-1.0)
-* 🗣 [Whisper](https://github.com/basetenlabs/truss-examples/tree/main/whisper/whisper-truss)
-
-and [dozens more examples](https://github.com/basetenlabs/truss-examples/).
-
-## Installation
-
-Install Truss with:
-
-```
-pip install --upgrade truss
-```
-
-## Quickstart
-
-As a quick example, we'll package a [text classification pipeline](https://huggingface.co/docs/transformers/main_classes/pipelines) from the open-source [`transformers` package](https://github.com/huggingface/transformers).
-
-### Create a Truss
-
-To get started, create a Truss with the following terminal command:
-
-```sh
-truss init text-classification
-```
-
-When prompted, give your Truss a name like `Text classification`.
-
-Then, navigate to the newly created directory:
-
-```sh
-cd text-classification
-```
-
-### Implement the model
-
-One of the two essential files in a Truss is `model/model.py`. In this file, you write a `Model` class: an interface between the ML model that you're packaging and the model server that you're running it on.
-
-There are two member functions that you must implement in the `Model` class:
-
-* `load()` loads the model onto the model server. It runs exactly once when the model server is spun up or patched.
-* `predict()` handles model inference. It runs every time the model server is called.
-
-Here's the complete `model/model.py` for the text classification model:
-
-```python
-from transformers import pipeline
-
-
-class Model:
-    def __init__(self, **kwargs):
-        self._model = None
-
-    def load(self):
-        self._model = pipeline("text-classification")
-
-    def predict(self, model_input):
-        return self._model(model_input)
-```
-
-### Add model dependencies
-
-The other essential file in a Truss is `config.yaml`, which configures the model serving environment. For a complete list of the config options, see [the config reference](https://truss.baseten.co/reference/config).
-
-The pipeline model relies on [Transformers](https://huggingface.co/docs/transformers/index) and [PyTorch](https://pytorch.org/). These dependencies must be specified in the Truss config.
-
-In `config.yaml`, find the line `requirements`. Replace the empty list with:
-
-```yaml
-requirements:
-  - torch==2.0.1
-  - transformers==4.30.0
-```
-
-No other configuration is needed.
-
-## Deployment
-
-Truss is maintained by [Baseten](https://baseten.co), which provides infrastructure for running ML models in production. We'll use Baseten as the remote host for your model.
-
-Other remotes are coming soon, starting with AWS SageMaker.
-
-### Get an API key
-
-To set up the Baseten remote, you'll need a [Baseten API key](https://app.baseten.co/settings/account/api_keys). If you don't have a Baseten account, no worries, just [sign up for an account](https://app.baseten.co/signup/) and you'll be issued plenty of free credits to get you started.
-
-### Run `truss push`
-
-With your Baseten API key ready to paste when prompted, you can deploy your model:
-
-```sh
-truss push
-```
-
-You can monitor your model deployment from [your model dashboard on Baseten](https://app.baseten.co/models/).
-
-### Invoke the model
-
-After the model has finished deploying, you can invoke it from the terminal.
-
-**Invocation**
-
-```sh
-truss predict -d '"Truss is awesome!"'
-```
-
-**Response**
-
-```json
-[
-  {
-    "label": "POSITIVE",
-    "score": 0.999873161315918
-  }
-]
-```
-
-## Truss contributors
-
-Truss is backed by Baseten and built in collaboration with ML engineers worldwide. Special thanks to [Stephan Auerhahn](https://github.com/palp) @ [stability.ai](https://stability.ai/) and [Daniel Sarfati](https://github.com/dsarfati) @ [Salad Technologies](https://salad.com/) for their contributions.
-
-We enthusiastically welcome contributions in accordance with our [contributors' guide](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md).

context_builder.Dockerfile

@@ -1,24 +0,0 @@
-# Builds baseten/truss-context-builder, a light-weight image that can be used
-# for creating docker build context out of a Truss.
-# Build that image as:
-# docker buildx build . -f context_builder.Dockerfile --platform=linux/amd64 -t baseten/truss-context-builder
-FROM python:3.9-slim
-
-RUN apt-get update \
-    && apt-get install --yes --no-install-recommends curl tar \
-    && apt-get autoremove -y \
-    && apt-get clean -y \
-    && rm -rf /var/lib/apt/lists/* /tmp/library-scripts/
-
-RUN curl -sSL https://install.python-poetry.org | python -
-
-ENV PATH="/root/.local/bin:${PATH}"
-COPY ./truss ./truss
-COPY ./pyproject.toml ./pyproject.toml
-COPY ./poetry.lock ./poetry.lock
-COPY ./README.md ./README.md
-
-# https://python-poetry.org/docs/configuration/#virtualenvsin-project
-# to write to project root .venv file to be used for context builder test
-RUN poetry config virtualenvs.in-project true \
-    && poetry install --only builder

truss/blob/blob_backend.py

@@ -1,10 +0,0 @@
-from abc import ABC, abstractmethod
-from pathlib import Path
-
-
-class BlobBackend(ABC):
-    """A blob backend downloads large remote files."""
-
-    @abstractmethod
-    def download(self, url: str, download_to: Path):
-        raise NotImplementedError()

truss/blob/blob_backend_registry.py

@@ -1,23 +0,0 @@
-from typing import Dict
-
-from truss.blob.blob_backend import BlobBackend
-from truss.blob.http_public_blob_backend import HttpPublic
-from truss.constants import HTTP_PUBLIC_BLOB_BACKEND
-
-
-class _BlobBackendRegistry:
-    def __init__(self) -> None:
-        self._backends: Dict[str, BlobBackend] = {}
-        # Register default backend
-        self._backends[HTTP_PUBLIC_BLOB_BACKEND] = HttpPublic()
-
-    def register_backend(self, name: str, backend: BlobBackend):
-        self._backends[name] = backend
-
-    def get_backend(self, name: str):
-        if name not in self._backends:
-            raise ValueError(f"Backend {name} is not registered.")
-        return self._backends[name]
-
-
-BLOB_BACKEND_REGISTRY = _BlobBackendRegistry()

truss/blob/http_public_blob_backend.py

@@ -1,23 +0,0 @@
-import shutil
-from pathlib import Path
-
-import requests
-from truss.blob.blob_backend import BlobBackend
-
-BLOB_DOWNLOAD_TIMEOUT_SECS = 600  # 10 minutes
-
-
-class HttpPublic(BlobBackend):
-    """Downloads without auth, files must be publicly available."""
-
-    def download(self, URL: str, download_to: Path):
-        # Streaming download to keep memory usage low
-        resp = requests.get(
-            URL,
-            allow_redirects=True,
-            stream=True,
-            timeout=BLOB_DOWNLOAD_TIMEOUT_SECS,
-        )
-        resp.raise_for_status()
-        with download_to.open("wb") as file:
-            shutil.copyfileobj(resp.raw, file)

truss/build/__init__.py

@@ -1,2 +0,0 @@
-# flake8: noqa
-from .build import *