Metadata-Version: 2.4
Name: modelcat
Version: 1.3.0
Summary: A set of packages and utilities for ModelCat
Author-email: Jeremi Wojcicki <jeremi@etacompute.com>, Vedin Klovo <vedin.klovo@etacompute.com>
License: Copyright (c) 2023 ModelCat Inc.
        
        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.
        
Project-URL: Homepage, https://github.com/ModelCat/modelcat
Project-URL: Bug Reports, https://github.com/ModelCat/modelcat/issues
Project-URL: Source, https://github.com/ModelCat/modelcat
Keywords: modelcat,dataset,connector,upload
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: tqdm
Requires-Dist: getpass_asterisk
Requires-Dist: checksumdir
Requires-Dist: scandir
Requires-Dist: pycocotools
Requires-Dist: requests<3,>=2
Requires-Dist: retry
Requires-Dist: pydantic<2
Requires-Dist: Pillow
Provides-Extra: dev
Requires-Dist: check-manifest; extra == "dev"
Provides-Extra: test
Requires-Dist: coverage; extra == "test"
Dynamic: license-file

# ModelCat

## Introduction

This package provides public tools and utilities to be used alongside [ModelCat.ai](https://app.modelcat.ai/).

## Installation

ModelCat is currently supported on:
* Linux
* Windows 10/11
* macOS

### Prerequisites
* `AWS CLI v2`. For more information consult the installation guide: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
* `Python >=3.8` installation (you can use `conda` or virtual environments `venv`)
* `git` (if you intend to clone ModelCatConnector directly from github)

### Installing by cloning from GitHub

Start your terminal or command line.
```bash
# If using python venv or conda activate your environment e.g.:
conda activate modelcat_env
```

Clone and install the Python package:
```bash
cd ~/ # Will install in user folder
git clone https://github.com/ModelCat/modelcat.git
cd modelcat
pip install -e .
```

### Installing via `pip`

```bash
pip install modelcat
```

## User Guide

Currently the following functions are supported:
* ModelCatConnector for dataset validation and upload to ModelCat. 
See the [modelcat.connector README](src/modelcat/connector/README.md) for details:
  * Tool setup (one-time only)
  * Fetching external datasets (e.g., via Roboflow Universe)
  * Dataset validation
  * Dataset upload


## Running tests

```
# install tox test runner:
python -m pip install --user tox
python -m tox --help

# install developer dependencies of the package
cd [...]/modelcat
pip install -e .[dev]

# run tests
tox
```

## Developed by:

<img src="img/logo.svg" alt="ModelCat Logo" width="200"/>
