Metadata-Version: 2.1
Name: ml-base
Version: 0.1.1
Summary: Base classes and utilities that are useful for deploying ML models.
Home-page: https://github.com/schmidtbri/ml-base
Author: Brian Schmidt
Author-email: 6666331+schmidtbri@users.noreply.github.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: pydantic (>=1.5)

# ML Base Package
Base classes and utilities that are useful for deploying ML models.

This package is useful for creating abstractions around machine learning models that make it easier to deploy them into 
other software systems. 

## Installation 

To download the code and set up a development use these instructions. 

To download the source code execute this command:

```bash
git clone https://github.com/schmidtbri/ml-base
```

Then create a virtual environment and activate it:

```bash
# go into the project directory
cd ml-base

make venv

source venv/bin/activate
```

Install the dependencies:

```bash
make dependencies
```

## Running the Unit Tests
To run the unit test suite execute these commands:
```bash
# first install the test dependencies
make test-dependencies

# run the test suite
make test

# clean up the unit tests
make clean-test
```

