Make your data adaptable

Boost your machine learning productivity with Aligned, a Python package that centralise data logic for your machine learning systems. Define your data logic through an dataclass like interface, and let Aligned implement it across compoenents, saving valuable time and resources.

Get startedView on GitHub
is_negative_review.py
from aligned import model_contract, String
from movie_review import MovieReviewEmbedding, MovieReview
from sources import dataset_dir


review = MovieReview()
review_embedding = MovieReviewEmbedding()


@model_contract(
    name="movie_review_is_negative",
    input_features=[review_embedding.embedding],
    output_source=dataset_dir.csv_at("predictions.csv"),
    exposed_model=mlflow_server(...),
)
class MovieReviewIsNegative:
    file = String().as_entity()
    model_version = String().as_model_version()
    predicted_sentiment = (review
        .is_negative
        .as_classification_label()
    )


df = await MovieReviewIsNegative.query().all_predictions().to_pandas()

Introduction

Getting started

Learn about how Aligned works, and the problems it tries to solve in a few minutes.

Installation

Step-by-step guides to setting up your system and installing the library.

Architecture guide

Learn how the internals work and contribute.

Examples

See practical examples of how to use Aligned

Kickstarter Project

See an end-to-end ML project that you can use to get quickly up to speed.

Quick start

Here will we describe how you can quickly get started using Alinged.

Installing dependencies

Install aligned through your favorite Python package manager.

Pip

pip install aligned

Poetry

poetry add aligned

Now that aligned is installed, can we start describing our system data logic.

Getting help

Everyone will stuble upon some challenges. Therefore, we will happly help you whenever you need some guidance. The best way to get help will be to contact us in the Discord, so why not join us there already.

Submit an issue

The Aligned project is still in an early development phase. Therefore, some bugs may exists. However, if you know how to fix the problem, maybe submit an issue, or a PR and contribute.

Join the community

Our community have is just starting to grow. So get in touch and join us in our Discord.

Next
Idiology