datamint 1.2.4__tar.gz

datamint-1.2.4/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.3
+Name: datamint
+Version: 1.2.4
+Summary: A library for interacting with the Datamint API, designed for efficient data management, processing and Deep Learning workflows.
+Requires-Python: >=3.10
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: dev
+Provides-Extra: docs
+Requires-Dist: Deprecated (>=1.2.0)
+Requires-Dist: aiohttp (>=3.0.0,<4.0.0)
+Requires-Dist: aioresponses (>=0.7.8,<0.8.0) ; extra == "dev"
+Requires-Dist: albumentations (>=2.0.0)
+Requires-Dist: humanize (>=4.0.0,<5.0.0)
+Requires-Dist: lazy-loader (>=0.3.0)
+Requires-Dist: lightning
+Requires-Dist: matplotlib
+Requires-Dist: nest-asyncio (>=1.0.0,<2.0.0)
+Requires-Dist: nibabel (>=4.0.0)
+Requires-Dist: numpy
+Requires-Dist: opencv-python (>=4.0.0)
+Requires-Dist: pandas (>=2.0.0)
+Requires-Dist: platformdirs (>=4.0.0,<5.0.0)
+Requires-Dist: pydicom (>=3.0.0,<4.0.0)
+Requires-Dist: pylibjpeg (>=2.0.0,<3.0.0)
+Requires-Dist: pylibjpeg-libjpeg (>=2.0.0,<3.0.0)
+Requires-Dist: pytest (>=7.0.0,<8.0.0) ; extra == "dev"
+Requires-Dist: pytest-cov (>=4.0.0,<5.0.0) ; extra == "dev"
+Requires-Dist: pyyaml (>=5.0.0)
+Requires-Dist: requests (>=2.0.0,<3.0.0)
+Requires-Dist: responses (>=0.20.0,<0.21.0) ; extra == "dev"
+Requires-Dist: rich (>=10.0.0)
+Requires-Dist: setuptools (>=57.0) ; extra == "docs"
+Requires-Dist: sphinx (>=5.0) ; extra == "docs"
+Requires-Dist: sphinx-tabs (>=3.0.0) ; extra == "docs"
+Requires-Dist: sphinx_rtd_theme (>=2.0.0) ; extra == "docs"
+Requires-Dist: torch (>=1.2.0,!=2.3.0)
+Requires-Dist: torchvision (>=0.18.0)
+Requires-Dist: tqdm (>=4.0.0,<5.0.0)
+Description-Content-Type: text/markdown
+
+
+# Datamint python API
+
+![Build Status](https://github.com/SonanceAI/datamint-python-api/actions/workflows/run_test.yaml/badge.svg)
+
+See the full documentation at https://sonanceai.github.io/datamint-python-api/
+
+## Installation
+
+Datamint requires Python 3.10+.
+You can install Datamint and its dependencies using pip
+
+```bash
+pip install git+https://github.com/SonanceAI/datamint-python-api
+```
+
+Soon we will be releasing the package on PyPi.
+We recommend that you install Datamint in a dedicated virtual environment, to avoid conflicting with your system packages.
+Create the enviroment once with `python3 -m venv datamint-env` and then activate it whenever you need it with:
+- `source datamint-env/bin/activate` (Linux/MAC)
+- `datamint-env\Scripts\activate.bat` (Windows CMD)
+- `datamint-env\Scripts\Activate.ps1` (Windows PowerShell)
+
+
+## Setup API key
+
+To use the Datamint API, you need to setup your API key (ask your administrator if you don't have one). Use one of the following methods to setup your API key:
+
+### Method 1: Command-line tool (recommended)
+
+Run ``datamint-config`` in the terminal and follow the instructions. See [command_line_tools](https://sonanceai.github.io/datamint-python-api/command_line_tools.html) for more details.
+
+### Method 2: Environment variable
+
+Specify the API key as an environment variable.
+
+**Bash:**
+```bash
+export DATAMINT_API_KEY="my_api_key"
+# run your commands (e.g., `datamint-upload`, `python script.py`)
+```
+
+**Python:**
+```python
+import os
+os.environ["DATAMINT_API_KEY"] = "my_api_key"
+```
+
+### Method 3: APIHandler constructor
+
+Specify API key in the |APIHandlerClass| constructor:
+
+```python
+from datamintapi import APIHandler
+api = APIHandler(api_key='my_api_key')
+```
+
+## Tutorials
+
+
+You can find example notebooks in the `notebooks` folder:
+
+- [Uploading your resources](notebooks/upload_data.ipynb)
+- [Uploading model segmentations](notebooks/upload_model_segmentations.ipynb)
+
+and example scripts in [examples](examples) folder:
+
+- [Running an experiment for classification](examples/experiment_traintest_classifier.py)
+- [Running an experiment for segmentation](examples/experiment_traintest_segmentation.py)
+
+## Full documentation
+
+See all functionalities in the full documentation at https://sonanceai.github.io/datamint-python-api/
+

datamint-1.2.4/README.md

@@ -0,0 +1,73 @@
+
+# Datamint python API
+
+![Build Status](https://github.com/SonanceAI/datamint-python-api/actions/workflows/run_test.yaml/badge.svg)
+
+See the full documentation at https://sonanceai.github.io/datamint-python-api/
+
+## Installation
+
+Datamint requires Python 3.10+.
+You can install Datamint and its dependencies using pip
+
+```bash
+pip install git+https://github.com/SonanceAI/datamint-python-api
+```
+
+Soon we will be releasing the package on PyPi.
+We recommend that you install Datamint in a dedicated virtual environment, to avoid conflicting with your system packages.
+Create the enviroment once with `python3 -m venv datamint-env` and then activate it whenever you need it with:
+- `source datamint-env/bin/activate` (Linux/MAC)
+- `datamint-env\Scripts\activate.bat` (Windows CMD)
+- `datamint-env\Scripts\Activate.ps1` (Windows PowerShell)
+
+
+## Setup API key
+
+To use the Datamint API, you need to setup your API key (ask your administrator if you don't have one). Use one of the following methods to setup your API key:
+
+### Method 1: Command-line tool (recommended)
+
+Run ``datamint-config`` in the terminal and follow the instructions. See [command_line_tools](https://sonanceai.github.io/datamint-python-api/command_line_tools.html) for more details.
+
+### Method 2: Environment variable
+
+Specify the API key as an environment variable.
+
+**Bash:**
+```bash
+export DATAMINT_API_KEY="my_api_key"
+# run your commands (e.g., `datamint-upload`, `python script.py`)
+```
+
+**Python:**
+```python
+import os
+os.environ["DATAMINT_API_KEY"] = "my_api_key"
+```
+
+### Method 3: APIHandler constructor
+
+Specify API key in the |APIHandlerClass| constructor:
+
+```python
+from datamintapi import APIHandler
+api = APIHandler(api_key='my_api_key')
+```
+
+## Tutorials
+
+
+You can find example notebooks in the `notebooks` folder:
+
+- [Uploading your resources](notebooks/upload_data.ipynb)
+- [Uploading model segmentations](notebooks/upload_model_segmentations.ipynb)
+
+and example scripts in [examples](examples) folder:
+
+- [Running an experiment for classification](examples/experiment_traintest_classifier.py)
+- [Running an experiment for segmentation](examples/experiment_traintest_segmentation.py)
+
+## Full documentation
+
+See all functionalities in the full documentation at https://sonanceai.github.io/datamint-python-api/

datamint-1.2.4/datamint/__init__.py

@@ -0,0 +1,11 @@
+"""
+Datamint API package alias.
+
+This module serves as an alias for the datamintapi package.
+"""
+
+from datamintapi import *
+import importlib.metadata
+
+__name__ = "datamint"
+__version__ = importlib.metadata.version(__name__)

datamint-1.2.4/datamintapi/__init__.py

@@ -0,0 +1,25 @@
+"""
+Datamint API is a Python package that provides a simple interface to the Datamint API.
+"""
+import importlib.metadata
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
+    from .dataset.dataset import DatamintDataset as Dataset
+    from .apihandler.api_handler import APIHandler
+    from .experiment import Experiment
+else:
+    import lazy_loader as lazy
+
+    __getattr__, __dir__, __all__ = lazy.attach(
+        __name__,
+        submodules=['dataset', "dataset.dataset", "apihandler.api_handler", "experiment"],
+        submod_attrs={
+            "dataset.dataset": ["DatamintDataset"],
+            "dataset": ['Dataset'],
+            "apihandler.api_handler": ["APIHandler"],
+            "experiment": ["Experiment"],
+        },
+    )
+
+__name__ = "datamintapi"
+__version__ = importlib.metadata.version('datamint')