maite 0.3.5

Library of common types, protocols (a.k.a. structural subtypes), and utilities to support AI test and evaluation

MAITE (Modular AI Trustworthy Engineering)

A toolbox of common types, protocols, and tooling to support AI test and evaluation workflows.

MAITE is a library of common types, protocols (a.k.a. structural subtypes), and utilities for test and evaluation of supervised machine learning models. It is being developed under the Joint AI T&E Infrastructure Capability (JATIC) program. Its goal is to streamline the development of JATIC Python projects by ensuring seamless, synergistic workflows when working with MAITE-conforming Python packages for different test and evaluation tasks. To this end, MAITE seeks to eliminate redundancies that would otherwise be shared across – and burden – separate efforts in machine learning test and evalution. MAITE is designed to be a low-dependency, frequently-improved Python package that is installed by JATIC projects. The following is a brief overview of the current state of its submodules.

Installation

From Python Packaging Index (PyPI)

To install from the python packaging index (PyPI), run:

pip install maite

:information_source: You can install MAITE for a given release tag, e.g. v0.3.0, by running:

$ pip install git+ssh://[e-mail]/mit-ll-ai-technology/maite.git@v0.3.0

From Source

To clone this repository and install from source, run:

$ git clone https://github.com/mit-ll-ai-technology/maite
$ cd maite
$ pip install .

maite.protocols

Common types for machine learning test and evaluation

The protocols subpackage defines common types – such as an inference-mode object detector – to be leveraged across JATIC projects. These are specifically designed to be Python protocol classes, which support structural subtyping. As a result, developers and users can satisfy MAITE-typed interfaces without having to explicitly subclass. This ability helps to promote common interfaces across JATIC projects without introducing explicit inter-dependencies between them.

ArrayLike

One example of a MAITE protocol class is ArrayLike. An ArrayLike defines a common interface for objects that can be manipulated as arrays, regardless of the specific implementation. This allows code to be written in a more generic way, allowing it to work with different array-like objects without having to worry about the details of the specific implementation. With an ArrayLike protocol, vendors can write functions and algorithms that operate on arrays without JATIC defining the specific implementation of arrays to use.

import maite.protocols as pr

# ArrayLike requires objects that implement `__array__` or `__array_interface__`.
assert not isinstance([1, 2, 3], pr.ArrayLike)

import numpy as np
np_array = np.zeros((10, 10, 3), dtype=np.uint8)
assert isinstance(np_array, pr.ArrayLike)

import torch as tr
array = tr.as_tensor(np_array)
assert isinstance(array, pr.ArrayLike)

maite.testing

Support for rigorous software testing

The testing subpackage is designed to help developers create a rigorous automated test suite for their JATIC project. These include:

• Pytest fixtures for initializing test functions with common models, datasets, and other inputs that are useful for testing machine learning code.
• Functions running static type checking tests using pyright in a pytest test suite, including scans of both source code and example documentation code blocks.
• Hypothesis strategies for driving property-based tests of interfaces that leverage JATIC protocols.

Pyright Static Type Checking in Code

>>> def f(x: str):
...     return 1 + x
>>> pyright_analyze(f)
{'version': '1.1.281',
  'time': '1669686515154',
  'generalDiagnostics': [{'file': 'source.py',
    'severity': 'error',
    'message': 'Operator "+" not supported for types "Literal[1]" and "str"\n\xa0\xa0Operator "+" not supported for types "Literal[1]" and "str"',
    'range': {'start': {'line': 1, 'character': 11},
    'end': {'line': 1, 'character': 16}},
    'rule': 'reportGeneralTypeIssues'}],
  'summary': {'filesAnalyzed': 20,
  'errorCount': 1,
  'warningCount': 0,
  'informationCount': 0,
  'timeInSec': 0.319}}

maite.interop

MAITE-compatible wrappers for popular 3rd-party libraries

The interop subpackage provides wrappers and functions that allow use of popular 3rd party libraries and frameworks in ways that are compatible with JATIC protocols. For example, this module can be used to wrap the object detectors provided by HuggingFace so that they adhere to the JATIC protocols for object detectors.

>>> from maite import load_dataset
>>> dataset = load_dataset(
...     provider="torchvision",
...     dataset_name="CIFAR10",
...     task="image-classification",
...     split="test",
...     root="~/data",
...     download=True
... )

maite.utils

General utilities

• Functions for validating the types and values of user arguments, with explicit and consistent user-error messages, that raise MAITE-customized exceptions.
• Specialized PyTorch utilities to help facilitate safe and ergonomic code patterns for manipulating stateful torch objects
• Other quality assurance and convenience functions that may be widely useful across projects

Disclaimer

DISTRIBUTION STATEMENT A. Approved for public release. Distribution is unlimited.

© 2023 MASSACHUSETTS INSTITUTE OF TECHNOLOGY

• Subject to FAR 52.227-11 – Patent Rights – Ownership by the Contractor (May 2014)
• SPDX-License-Identifier: MIT

This material is based upon work supported by the Under Secretary of Defense for Research and Engineering under Air Force Contract No. FA8702-15-D-0001. Any opinions, findings, conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the Under Secretary of Defense for Research and Engineering.

The software/firmware is provided to you on an As-Is basis