roboml 0.2.0__tar.gz

roboml-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Automatika Robotics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

roboml-0.2.0/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.1
+Name: roboml
+Version: 0.2.0
+Summary: Machine learning models optimized for robotics experimentation and deployment
+Author-email: Automatika Robotics <contact@automatikarobotics.com>
+Project-URL: Homepage, https://github.com/automatika-robotics/roboml
+Keywords: robots,robotics,machine learning,multimodal,deep learning
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: accelerate
+Requires-Dist: transformers
+Requires-Dist: bitsandbytes
+Requires-Dist: pillow
+Requires-Dist: msgpack
+Requires-Dist: msgpack_numpy
+Requires-Dist: hiredis
+Requires-Dist: ray[serve]
+Requires-Dist: sentencepiece
+Requires-Dist: datasets
+Requires-Dist: scipy
+Requires-Dist: sentence-transformers
+Requires-Dist: chromadb
+Requires-Dist: ninja
+Requires-Dist: packaging
+Provides-Extra: dev
+Requires-Dist: httpx; extra == "dev"
+Requires-Dist: pip-tools; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: redis; extra == "dev"
+Provides-Extra: vision
+Requires-Dist: mmengine; extra == "vision"
+Requires-Dist: platformdirs; extra == "vision"
+Requires-Dist: norfair; extra == "vision"
+
+# RoboML 🤖
+
+RoboML is an aggregator package written for quickly deploying open source ML models for robots. It is designed to cover two basic use cases.
+
+- __Readily deploy various useful models:__ The package provides a wrapper around the 🤗 [**Transformers**](https://github.com/huggingface/transformers) and [**SentenceTransformers**](https://www.sbert.net/) libraries. Pretty much all relevant open source models from these libraries can be quickly deployed behind a highly scalable server endpoint.
+- __Deploy Detection Models with Tracking__: With RoboML one can deploy all detection models available in [**MMDetection**](https://github.com/open-mmlab/mmdetection). An open source vision model aggregation library. These detection models can also be seemlesly used for tracking.
+- __Use Open Source Vector DBs__: RoboML provides a unified interface for deploying Vector DBs along with ML models. Currently it is packaged with [**ChromaDB**](https://www.trychroma.com/) an open source multimodal vector database.
+- __Aggregate robot specific ML models from the Robotics community__: RoboML aims to be an aggregator package of models trained by the robotics community. These models can range from Multimodal LLMs, vision models, or robot action models, and can be used with ROS based functional components. See the usage in [ROS Agents](https://automatika-robotics.github.io/ros-agents)
+
+## Installation
+
+RoboML has been tested on Ubuntu 20.04 and later. It should ideally be installed on a system with a GPU and CUDA 12.1. However, it should work without a GPU. If you encounter any installation problems, please open an issue.
+
+### From Source
+
+```shell
+git clone https://github.com/automatika-robotics/roboml.git && cd roboml
+virtualenv venv && source venv/bin/activate
+pip install pip-tools
+pip install .
+```
+
+### For vision model support
+
+If you want to utilize detection and tracking using Vision models from the MMDetection library, you will need to install a couple of dependancies as follows:
+
+- Install roboml using the vision flag:
+`pip install roboml[vision]`
+- Install mmcv using the installation instructions provided [here](https://mmcv.readthedocs.io/en/latest/get_started/installation.html). For installation with pip, simply pick PyTorch and CUDA version that you have installed and copy the pip installation command generated.
+- Install mmdetection as follows:
+```shell
+git clone https://github.com/open-mmlab/mmdetection.git
+cd mmdetection
+pip install -v -e .
+```
+
+## Build in a Docker container (Recommended)
+
+- Install docker desktop.
+- Install [NVIDIA toolkit for Docker](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)
+```shell
+git clone https://github.com/automatika-robotics/roboml.git && cd roboml
+docker build --tag=automatika:roboml .
+docker run --runtime=nvidia --gpus all --rm -p 8000:8000 automatika:roboml
+```
+
+## Servers
+
+By default roboml starts models as [ray serve](https://docs.ray.io/en/latest/serve/index.html) apps. Making the models scalable accross multiple infrastructure configurations. See [ray serve](https://docs.ray.io/en/latest/serve/index.html) for details.
+
+### An Experimental Server based on RESP
+
+When using ML models on robots, latency is a major consideration. When models are deployed on distributed infrastructure (and not on the edge, due to compute limitations), latency depends on both the model inference time and server communication time. Therefore, RoboML also implements an experimental server built using [RESP](https://github.com/antirez/RESP3) which can be accessed using any redis client. RESP is a human readable binary safe protocol, which is very simple to parse and thus can be used to implement servers significatly faster than HTTP, specially when the payloads are also packaged binary data (for example images, audio or video data). The RESP server uses msgpack a cross-platform library available in over 50 languages, to package data instead of JSON. Work on the server was inspired by earlier work of [@hansonkd](https://github.com/hansonkd) and his [Tino](https://github.com/hansonkd/Tino) project.
+
+## Usage
+
+To run an HTTP server simply run the following in the terminal
+
+`roboml`
+
+To run an RESP based server, run
+
+`roboml-resp`
+
+In order to see how these servers are called from a ROS package that implements its clients, please refer to [ROS Agents](https://automatika-robotics.github.io/ros-agents) documentation.
+
+## Running Tests
+
+To run tests, install with:
+
+`pip install ".[dev]"`
+
+And run the following in the root directory
+
+`python -m pytest`
+
+## Copyright
+
+The code in this distribution is Copyright (c) 2024 Automatika Robotics unless explicitly indicated otherwise.
+
+ROS Agents is made available under the MIT license. Details can be found in the [LICENSE](LICENSE) file.
+
+## Contributions
+
+ROS Agents has been developed in collaboration betweeen [Automatika Robotics](https://automatikarobotics.com/) and [Inria](https://inria.fr/). Contributions from the community are most welcome.

roboml-0.2.0/README.md

@@ -0,0 +1,85 @@
+# RoboML 🤖
+
+RoboML is an aggregator package written for quickly deploying open source ML models for robots. It is designed to cover two basic use cases.
+
+- __Readily deploy various useful models:__ The package provides a wrapper around the 🤗 [**Transformers**](https://github.com/huggingface/transformers) and [**SentenceTransformers**](https://www.sbert.net/) libraries. Pretty much all relevant open source models from these libraries can be quickly deployed behind a highly scalable server endpoint.
+- __Deploy Detection Models with Tracking__: With RoboML one can deploy all detection models available in [**MMDetection**](https://github.com/open-mmlab/mmdetection). An open source vision model aggregation library. These detection models can also be seemlesly used for tracking.
+- __Use Open Source Vector DBs__: RoboML provides a unified interface for deploying Vector DBs along with ML models. Currently it is packaged with [**ChromaDB**](https://www.trychroma.com/) an open source multimodal vector database.
+- __Aggregate robot specific ML models from the Robotics community__: RoboML aims to be an aggregator package of models trained by the robotics community. These models can range from Multimodal LLMs, vision models, or robot action models, and can be used with ROS based functional components. See the usage in [ROS Agents](https://automatika-robotics.github.io/ros-agents)
+
+## Installation
+
+RoboML has been tested on Ubuntu 20.04 and later. It should ideally be installed on a system with a GPU and CUDA 12.1. However, it should work without a GPU. If you encounter any installation problems, please open an issue.
+
+### From Source
+
+```shell
+git clone https://github.com/automatika-robotics/roboml.git && cd roboml
+virtualenv venv && source venv/bin/activate
+pip install pip-tools
+pip install .
+```
+
+### For vision model support
+
+If you want to utilize detection and tracking using Vision models from the MMDetection library, you will need to install a couple of dependancies as follows:
+
+- Install roboml using the vision flag:
+`pip install roboml[vision]`
+- Install mmcv using the installation instructions provided [here](https://mmcv.readthedocs.io/en/latest/get_started/installation.html). For installation with pip, simply pick PyTorch and CUDA version that you have installed and copy the pip installation command generated.
+- Install mmdetection as follows:
+```shell
+git clone https://github.com/open-mmlab/mmdetection.git
+cd mmdetection
+pip install -v -e .
+```
+
+## Build in a Docker container (Recommended)
+
+- Install docker desktop.
+- Install [NVIDIA toolkit for Docker](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)
+```shell
+git clone https://github.com/automatika-robotics/roboml.git && cd roboml
+docker build --tag=automatika:roboml .
+docker run --runtime=nvidia --gpus all --rm -p 8000:8000 automatika:roboml
+```
+
+## Servers
+
+By default roboml starts models as [ray serve](https://docs.ray.io/en/latest/serve/index.html) apps. Making the models scalable accross multiple infrastructure configurations. See [ray serve](https://docs.ray.io/en/latest/serve/index.html) for details.
+
+### An Experimental Server based on RESP
+
+When using ML models on robots, latency is a major consideration. When models are deployed on distributed infrastructure (and not on the edge, due to compute limitations), latency depends on both the model inference time and server communication time. Therefore, RoboML also implements an experimental server built using [RESP](https://github.com/antirez/RESP3) which can be accessed using any redis client. RESP is a human readable binary safe protocol, which is very simple to parse and thus can be used to implement servers significatly faster than HTTP, specially when the payloads are also packaged binary data (for example images, audio or video data). The RESP server uses msgpack a cross-platform library available in over 50 languages, to package data instead of JSON. Work on the server was inspired by earlier work of [@hansonkd](https://github.com/hansonkd) and his [Tino](https://github.com/hansonkd/Tino) project.
+
+## Usage
+
+To run an HTTP server simply run the following in the terminal
+
+`roboml`
+
+To run an RESP based server, run
+
+`roboml-resp`
+
+In order to see how these servers are called from a ROS package that implements its clients, please refer to [ROS Agents](https://automatika-robotics.github.io/ros-agents) documentation.
+
+## Running Tests
+
+To run tests, install with:
+
+`pip install ".[dev]"`
+
+And run the following in the root directory
+
+`python -m pytest`
+
+## Copyright
+
+The code in this distribution is Copyright (c) 2024 Automatika Robotics unless explicitly indicated otherwise.
+
+ROS Agents is made available under the MIT license. Details can be found in the [LICENSE](LICENSE) file.
+
+## Contributions
+
+ROS Agents has been developed in collaboration betweeen [Automatika Robotics](https://automatikarobotics.com/) and [Inria](https://inria.fr/). Contributions from the community are most welcome.

roboml-0.2.0/pyproject.toml

@@ -0,0 +1,104 @@
+[build-system]
+requires = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "roboml"
+version = "0.2.0"
+description = "Machine learning models optimized for robotics experimentation and deployment"
+authors = [{ name = "Automatika Robotics", email = "contact@automatikarobotics.com" }]
+readme = "README.md"
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
+keywords = ["robots", "robotics", "machine learning", "multimodal", "deep learning"]
+dependencies = [
+    "accelerate",
+    "transformers",
+    "bitsandbytes",
+    "pillow",
+    "msgpack",
+    "msgpack_numpy",
+    "hiredis",
+    "ray[serve]",
+    "sentencepiece",
+    "datasets",
+    "scipy",
+    "sentence-transformers",
+    "chromadb",
+    "ninja",
+    "packaging",
+]
+
+requires-python = ">=3.10"
+
+[project.optional-dependencies]
+dev = ["httpx", "pip-tools", "pytest", "pre-commit", "black", "redis"]
+vision = ["mmengine", "platformdirs", "norfair"]
+
+[project.scripts]
+roboml = "roboml.main:ray"
+roboml-resp = "roboml.main:resp"
+
+[project.urls]
+Homepage = "https://github.com/automatika-robotics/roboml"
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "-ra -q"
+log_cli = true
+log_cli_level = "INFO"
+log_cli_format="[%(levelname)s] [%(asctime)s] [%(name)s] [%(process)d-%(thread)d] %(message)s"
+testpaths = [
+    "tests"
+]
+markers = ["module(module_name): mark test to pass module name to fixture"]
+
+[tool.interrogate]
+ignore-init-method = true
+ignore-init-module = false
+ignore-magic = false
+ignore-semiprivate = false
+ignore-private = false
+ignore-property-decorators = false
+ignore-module = true
+ignore-nested-functions = false
+ignore-nested-classes = true
+ignore-setters = false
+exclude = ["setup.py", "docs", "build"]
+ignore-regex = ["^get$", "^mock_.*", ".*BaseClass.*"]
+quiet = false
+whitelist-regex = []
+color = true
+generate-badge = "."
+badge-format = "svg"
+
+[tool.ruff]
+extend-exclude = [".mypy_cache", ".tox", ".venv", "buck-out", "build", ".pytest_cache"]
+fix = true
+line-length = 88
+preview = true
+[tool.ruff.lint]
+ignore = ["E203", "E266", "E501", "F403", "F401"]
+select = ["B","C","E","F","W","B9"]
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.bumpver]
+current_version = "0.2.0"
+version_pattern = "MAJOR.MINOR.PATCH"
+commit_message = "(chore) bump version {old_version} -> {new_version}"
+tag_message = "{new_version}"
+tag_scope = "default"
+pre_commit_hook = ""
+post_commit_hook = ""
+commit = true
+tag = true
+push = true
+
+[tool.bumpver.file_patterns]
+"pyproject.toml" = [
+    'version = "{version}"',
+]

roboml-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

roboml-0.2.0/src/roboml/databases/__init__.py

@@ -0,0 +1,5 @@
+from .chroma import ChromaDB
+
+__all__ = [
+    "ChromaDB",
+]

roboml-0.2.0/src/roboml/databases/_base.py

@@ -0,0 +1,166 @@
+from abc import abstractmethod
+from logging import Logger
+import inspect
+
+from pydantic import validate_call, ValidationError
+
+
+from roboml.models._encoding import EncodingModel
+from roboml.utils import Status, logging
+
+
+class VectorDBTemplate:
+    """
+    This class describes a VectorDB template.
+    """
+
+    def __init__(self, *, name: str, **_):
+        """__init__.
+        :param name:
+        :type name: str
+        :param _:
+        """
+        self.name: str = name
+        self.encoding_model: EncodingModel
+        self.logger: Logger = logging.getLogger(self.name)
+        self.status: Status = Status.LOADED
+
+    def initialize(self, **kwargs) -> None:
+        """
+        Calls the db initialization function and sets status accordingly
+        """
+        if self.status == Status.READY:
+            return
+
+        self.status = Status.INITIALIZING
+        try:
+            validated_init = validate_call(self._initialize)
+            validated_init(**kwargs)
+        except Exception as e:
+            self.logger.error(f"Initialization Error: {e}")
+            self.status = Status.INITIALIZATION_ERROR
+            raise e
+        self.logger.info(f"{self.__class__.__name__} VectorDB initialized")
+        self.status = Status.READY
+
+    def get_status(self):
+        """Returns status of the model node"""
+        return self.status.name
+
+    def add(self, **kwargs) -> dict:
+        """VectorDB specific add function.
+        :param kwargs:
+        :rtype: None
+        """
+        if self.status is not Status.READY:
+            self.logger.error("Error: DB method called before initialization")
+            raise Exception("DB Method Called called before initialization")
+        try:
+            data_model = inspect.signature(self._add).parameters["data"].annotation
+            data = data_model(**kwargs)
+        except ValidationError:
+            self.logger.error("Validation Error occured for inference input")
+            raise
+        return self._add(data)
+
+    def conditional_add(self, **kwargs) -> dict:
+        """VectorDB specific conditional_add function.
+        :param kwargs:
+        :rtype: None
+        """
+        if self.status is not Status.READY:
+            self.logger.error("Error: DB method called before initialization")
+            raise Exception("DB Method Called called before initialization")
+        try:
+            data_model = (
+                inspect.signature(self._conditional_add).parameters["data"].annotation
+            )
+            data = data_model(**kwargs)
+        except ValidationError:
+            self.logger.error("Validation Error occured for inference input")
+            raise
+        return self._conditional_add(data)
+
+    def metadata_query(self, **kwargs) -> dict:
+        """VectorDB specific metadata_query function.
+        :param kwargs:
+        :rtype: None
+        """
+        if self.status is not Status.READY:
+            self.logger.error("Error: DB method called before initialization")
+            raise Exception("DB Method Called called before initialization")
+        try:
+            data_model = (
+                inspect.signature(self._metadata_query).parameters["data"].annotation
+            )
+            data = data_model(**kwargs)
+        except ValidationError:
+            self.logger.error("Validation Error occured for inference input")
+            raise
+        return self._metadata_query(data)
+
+    def query(self, **kwargs) -> dict:
+        """VectorDB specific query function.
+        :param kwargs:
+        :rtype: None
+        """
+        if self.status is not Status.READY:
+            self.logger.error("Error: DB method called before initialization")
+            raise Exception("DB Method Called called before initialization")
+        try:
+            data_model = inspect.signature(self._query).parameters["data"].annotation
+            data = data_model(**kwargs)
+        except ValidationError:
+            self.logger.error("Validation Error occured for inference input")
+            raise
+        return self._query(data)
+
+    @abstractmethod
+    def _initialize(self, *_, **__) -> None:
+        """VectorDB specific initialize function, to be implemented in derived classes.
+        :param kwargs:
+        :rtype: None
+        """
+        raise NotImplementedError(
+            "VectorDB specific initialize method needs to be implemented by derived classes"
+        )
+
+    @abstractmethod
+    def _add(self, *_, **__) -> dict:
+        """VectorDB specific add function, to be implemented in derived classes.
+        :param kwargs:
+        :rtype: None
+        """
+        raise NotImplementedError(
+            "VectorDB specific add method needs to be implemented by derived classes"
+        )
+
+    @abstractmethod
+    def _conditional_add(self, *_, **__) -> dict:
+        """VectorDB specific conditional_add function, to be implemented in derived classes.
+        :param kwargs:
+        :rtype: None
+        """
+        raise NotImplementedError(
+            "VectorDB specific conditional_add method needs to be implemented by derived classes"
+        )
+
+    @abstractmethod
+    def _metadata_query(self, *_, **__) -> dict:
+        """VectorDB specific metadata_query function, to be implemented in derived classes.
+        :param kwargs:
+        :rtype: None
+        """
+        raise NotImplementedError(
+            "VectorDB specific metadata_query method needs to be implemented by derived classes"
+        )
+
+    @abstractmethod
+    def _query(self, *_, **__) -> dict:
+        """VectorDB specific query function, to be implemented in derived classes.
+        :param kwargs:
+        :rtype: None
+        """
+        raise NotImplementedError(
+            "VectorDB specific query method needs to be implemented by derived classes"
+        )