AccelForge
==========

AccelForge is a framework to model and design tensor algebra and deep neural network
accelerators.

Quick Start
-----------

New to AccelForge? Start with the :doc:`guide/guide` for installation instructions,
examples, and an introduction to key concepts.

The ``accelforge`` repo includes tutorials and examples to help you get started.

.. code-block:: bash

   pip install accelforge jupyterlab ipywidgets
   git clone https://github.com/accelergy-project/accelforge.git
   cd accelforge/notebooks/tutorials
   jupyter notebook

Documentation
-------------

**User Guide**

The :doc:`guide/guide` contains everything you need to get started with AccelForge,
including installation, tutorials, and core concepts.

**API Reference**

The :doc:`modules` provides detailed documentation of all AccelForge modules, classes,
and functions.

.. toctree::
   :maxdepth: 1
   :caption: User Guide
   :hidden:

   guide/guide
   modules

**Citing AccelForge**

If you use AccelForge in your work, please refer to :doc:`guide/citation` for how to cite
the relevant projects.

.. toctree::
   :maxdepth: 1
   :caption: Citing AccelForge
   :hidden:

   guide/citation

**Contributing to AccelForge**

We welcome contributions to AccelForge! If you'd like to contribute, please see
:doc:`guide/contributing` for how to get started.

.. toctree::
   :maxdepth: 1
   :caption: Contributing to AccelForge
   :hidden:

   guide/contributing

**Source Code**

The AccelForge source code is available on `GitHub
<https://github.com/Accelergy-Project/accelforge>`_.