.. TrAILMET documentation master file, created by
   sphinx-quickstart on Thu Mar 30 13:09:23 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. raw:: html

    <style> .red {color:#aa0060; font-weight:bold; font-size:16px} </style>

.. role:: red

************************************
Welcome to TrAILMET's documentation!
************************************

Transmute AI Model Efficiency Toolkit (TrAILMET)
================================================
Transmute AI Model Efficiency Toolkit is an efficient and scalable library for making machine learning time, energy, cost, and compute efficient
built on top of pytorch.

**Background:** Trailmet is a model efficiency toolkit for compressing deep learning models using state of the art compression techniques.
Today deep learning models are not deployable because of their huge memory footprint, TRAILMET is an effort to make deep learning models more efficient in their size to performance ratio.
It is developed using Pytorch 1.13.

Major features
--------------
- State of the art compression algorithms implemented.
- Demo notebooks for training each algorithm.
- Modular Design: All alogithms are modular and can customized easily for any kind of model and dataset.


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   strategies/modules