.. TorchCAP documentation master file, created by
   sphinx-quickstart on Wed Mar 26 14:44:20 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

SysSim documentation
======================

Overview of SysSim
^^^^^^^^^^^^^^^^^^^^

**Main Components**

* System Cost Estimator
  
  * Predict the runtime and memory consumption of a model program

* Execution Plan Optimizer
  
  * Transform the model execution plan based on the cost estimation

.. image:: img/torchCAP_overview.png
  :alt: SysSim Overview
  :align: center
  :width: 100%



Applications in AI Infrastructure
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* automatic parallelism
* resource scheduling 
* performance debugging

.. image:: img/refine_hardware_with_torchcap.png
  :alt: Refine Hardware with SysSim
  :align: center
  :width: 100%

Checklist
=========

- Code ✅
- Documentation
   - Installation ✅
   - Quick Start ✅
   - Cost Model ✅
   - Auto-Sharding ✅
- Benchmark ✅



.. Add your content using ``reStructuredText`` syntax. See the
.. `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
.. documentation for details.


.. Include the background, motivation, and goals of the project here.
.. toctree::
  :maxdepth: 1
  :caption: Getting Started

  install.rst
  quickstart.rst

.. Include the methodology, and architecture of the project here.
.. toctree::
  :maxdepth: 1
  :caption: Deep Dive

  cost_model.rst
  auto_sharding.rst

.. toctree::
  :maxdepth: 1
  :caption: Benchmark

  benchmark.rst