Metadata-Version: 2.3
Name: ml-ajp
Version: 0.1.0
Summary: An example project
Author: Alan Perry
Author-email: Alan Perry <alan.jacob.perry@gmail.com>
License: MIT License
         
         Copyright (c) 2026 Alan Perry
         
         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.
Requires-Dist: pre-commit>=4.5.1
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# ML Base (ml_ajp)


![coverage](https://gitlab.perryfamily.house/all/ml-base/badges/main/coverage.svg)
![pipeline](https://gitlab.perryfamily.house/all/ml-base/badges/main/pipeline.svg)
[![Imports: isort](https://img.shields.io/badge/imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

## Usage
Import this project into a domain specific repo and run utilities.

## Description
This package does not do the ML for you but provides tools to other ML projects which clean up code considerably.

## Development Installation
Install development dependencies with `make dev`

## Documentation
Automatically generated docs are available on the gitlab

<a href="https://pages.perryfamily.house/all/ml-base/html/index.html" target="_parent"><img src="https://gist.githubusercontent.com/cxmeel/0dbc95191f239b631c3874f4ccf114e2/raw/bb4634715f95ebb209b4e0bcdd4d2d98fe64c64c/documentation-compact.svg"/></a>

## Roadmap
- Logging with wandb
- Packaging and building to pypi
- Training with sagemaker
- Deployment to AWS

## Contributing
All members are free to submit pull requests.

## License
MIT Licenced
