cmn-ai 0.0.2

No project description provided

Welcome to cmn_ai

Introduction

I am a big believer in Boyd's Law, which states that speed of iteration beats quality of iteration. Following this principle, I created cmn_ai to incorporate the most common tasks we encounter in ML/AI from data exploration to model development and training. Additionally, I baked into it some of the best practices I learned in my career so I don't have to repeat myself on every project I work on.

It is worth noting that the majority of the DL code such as Learner and callbacks assume that pytorch is used as the underlying DL library. Also, tabular data preprocessors/models are compatible with sklearn so they can be used easily with its Pipeline or ColumnTransformer.

Given the nature of the progress in ML/AI, I will always keep adding more functionalities as time passes.

Installation

The easiest way to install cmn_ai is by using pip:

pip install cmn-ai

Documentation

The official documentation is hosted on https://imaddabbura.github.io/cmn_ai/.

Development setup

The fastest way to setup the development environment is to use poetry. You can install poetry using pip (or conda).

pip install poetry

Then install cmn_ai from source as follows:

git clone https://github.com/ImadDabbura/cmn_ai
cd cmn_ai
poetry install

Tests

To run tests, run the following command:

poetry run pytest

Contributing

cmn_ai is not open now for contribution because there are some infrastructure work I need to finish to make it ready for more contributors.

License

cmn_ai has Apache License, as found in the LICENCE file.