.. _cerebras-docs:


Explore the Documentation
=========================

.. raw:: html

  <div class="container-fluid">
  <p style="font-size: 1.05em">This documentation will help you program for the CS system. It covers both basic and advanced topics. Use these docs to accelerate your machine learning training and inference applications on the CS system. Here you will find getting started guides, quickstarts, tutorials, code examples, release notes, and more.
  </p>


  <h2>Learn Cerebras basics</h2>

  <div class="timeline">
  <div class="timeline-outer">
  <div class="timeline-card">
    <div class="timeline-info">
      <timeline-h3 class="timeline-title">How Cerebras works</timeline-h3>
      <a href="cerebras-basics/how-cerebras-works.html" class="card-link">How Cerebras works</a>
      <p>Start by learning the basics about how Cerebras systems are deployed and used.</p>
      <a href="cerebras-basics/how-cerebras-works.html#installations" class="card-link">Cerebras installations</a>
      <p>Cerebras offers two forms of deployment for CS systems, Wafer-Scale clusters and Original Cerebras installations. Which one do you have?</p>
      <a href="cerebras-basics/how-cerebras-works.html#cerebras-software" class="card-link">Cerebras Software Platform</a>
      <p>The Cerebras Graph Compiler (CGC) compiles your ML code into a binary for execution on a CS system.</p>
      <a href="cerebras-basics/how-cerebras-works.html#execution_modes" class="card-link">Pipelined and Weight Streaming execution</a>
      <p>Cerebras Software Platform supports two execution modes on CS systems.</p>
    </div>
  </div>
  <div class="timeline-card">
    <div class="timeline-info">
      <timeline-h3 class="timeline-title">Types of CS systems installations in more details</timeline-h3>
      <a href="cerebras-basics/cerebras-installations.html" class="card-link">Types of installations</a>
      <p>Learn about Wafer-Scale cluster and Original Cerebras installation and what execution modes are supported by them.</p>
    </div>
  </div>
  <div class="timeline-card">
    <div class="timeline-info">
      <timeline-h3 class="timeline-title">Execution modes in more details</timeline-h3>
      <a href="cerebras-basics/cerebras-execution-modes.html" class="card-link">Pipelined and Weight Streaming modes</a>
      <p>How Pipelined and Weight Streaming work.</p>
    </div>
  </div>
  <div class="timeline-card">
    <div class="timeline-info">
      <timeline-h3 class="timeline-title">ML workflow on Cerebras</timeline-h3>
      <a href="cerebras-basics/cs-ml-workflow.html" class="card-link">Cerebras ML workflow</a>
      <p>Whether your framework is TensorFlow or PyTorch, get to know the general ML workflow on Cerebras first.</p>
    </div>
  </div>
  </div>
  </div>

  <h2> Quickstarts</h2>

  <div class="timeline">
  <div class="timeline-outer">
  <div class="timeline-card">
    <div class="timeline-info">
      <timeline-h3 class="timeline-title">Quickstarts for Wafer-Scale Cluster</timeline-h3>
    </div>
  </div>
  </div>
  </div>

  <div class="row">

      <div class="col">
          <div class="card h-100" >
              <div class="card-body">
                  <h3 class="card-title">TensorFlow: Getting Started</h3>
                  <a href="getting-started/tensorflow/index.html">Quick-Start Guide with a Simple TensorFlow Model on a Cerebras Wafer-Scale Cluster</a>
              </div>
          </div>
      </div>
      <div class="col">
          <div class="card h-100" >
              <div class="card-body">
                  <h3 class="card-title">PyTorch: Getting Started</h3>
                  <a href="getting-started/pytorch/index.html" class="card-link">Quick-Start Guide with a Simple PyTorch Model on a Cerebras Wafer-Scale Cluster</a>
              </div>
          </div>
      </div>
      
  </div>


  <div class="timeline">
  <div class="timeline-outer">
  <div class="timeline-card">
    <div class="timeline-info">
      <timeline-h3 class="timeline-title">Quickstarts for Original Cerebras Installation</timeline-h3>
    </div>
  </div>
  </div>
  </div>

 <div class="row">

      <div class="col">
          <div class="card h-100" >
              <div class="card-body">
                  <h3 class="card-title">TensorFlow: Getting Started</h3>
                  <a href="getting-started/tensorflow/index2.html">Quick-Start Guide with a Simple TensorFlow Model in an Original Cerebras Installation</a>
              </div>
          </div>
      </div>
      <div class="col">
          <div class="card h-100" >
              <div class="card-body">
                  <h3 class="card-title">PyTorch: Getting Started</h3>
                  <a href="getting-started/pytorch/index2.html" class="card-link">Quick-Start Guide with a Simple PyTorch Model in an Original Cerebras Installation</a>
              </div>
          </div>
      </div>
      
  </div>


  <h2>Check out the reference models</h2>
  <div class="timeline">
  <div class="timeline-outer">
  <div class="timeline-card">
    <div class="timeline-info">
      <timeline-h3 class="timeline-title">Reference code</timeline-h3>
      <a href="https://github.com/Cerebras/modelzoo/tree/master/modelzoo" class="card-link">Cerebras Model Zoo Reference Models</a>
      <p>GitHub repo with a partial list of various neural network models currently supported. </p>
    </div>
  </div>
  </div>
  </div>


  <h2> Start developing</h2>
  <div class="timeline">
  <div class="timeline-outer">
  <div class="timeline-card">
    <div class="timeline-info">
      <timeline-h3 class="timeline-title">Dive into developing with TensorFlow and PyTorch</timeline-h3>

      <p>PyTorch or TensorFlow, we got you covered. Start your framework-to-CS journey here.</p>
    </div>
  </div>
  </div>
  </div>

  <div class="row">

      <div class="col">
          <div class="card h-100" >
              <div class="card-body">
                  <h3 class="card-title">Develop with TensorFlow</h3>
                  <a href="tensorflow-docs/cs-tf-workflow.html" class="card-link">Start your TensorFlow to CS journey here</a>
              </div>
          </div>
      </div>
      <div class="col">
          <div class="card h-100" >
              <div class="card-body">
                  <h3 class="card-title">Develop with PyTorch</h3>
                  <a href="pytorch-docs/pytorch-cs-workflow.html" class="card-link">Start your PyTorch to CS journey here</a>
              </div>
          </div>
      </div>

  </div>

  <!-- <h2>Optimize performance</h2> -->
  <div class="timeline">
  <div class="timeline-outer">
  <div class="timeline-card">
    <div class="timeline-info">
      <timeline-h3 class="timeline-title">Optimize your ML code</timeline-h3>
      <a href="general/performance-optimization.html" class="card-link">Performance optimization practices</a>
      <p>Determine optimal Slurm resources, use the compiler report to enhance input function. </p>

    </div>
  </div>
  </div>
  </div>


  <h2>Extensions</h2>
  <div class="timeline">
  <div class="timeline-outer">
  <div class="timeline-card">
    <div class="timeline-info">
      <timeline-h3 class="timeline-title">Extensions</timeline-h3>
      <a href="software-guides/adding-custom-pkgs-to-cbcore-container.html" class="card-link">Adding custom packages to cbcore</a>
    </div>
  </div>
  </div>
  </div>
  </div>

Contact
    For questions and feedback on documentation
    Contact ``docs@cerebras.net`` via email.

    For support
    Contact ``support@cerebras.net`` via email.

Cerebras company website
    Visit `cerebras.net <https://cerebras.net/>`_.


.. toctree::
  :maxdepth: 3
  :hidden:

  release-notes/rel-notes-cumulative.rst
  release-notes/doc-updates.rst

.. toctree::
  :caption: Cerebras Basics
  :maxdepth: 2
  :hidden:

  cerebras-basics/how-cerebras-works.rst
  cerebras-basics/cerebras-installations.rst
  cerebras-basics/cerebras-execution-modes.rst
  cerebras-basics/cs-ml-workflow.rst
  cerebras-basics/glossary.rst

.. toctree::
  :caption: Getting Started with Cerebras Wafer-Scale Cluster
  :maxdepth: 2
  :hidden:

  getting-started/software-dependencies.rst
  getting-started/pytorch/index.rst
  getting-started/tensorflow/index.rst

  
.. toctree::
  :caption: Getting Started with Original Cerebras Installation
  :maxdepth: 2
  :hidden:

  getting-started/software-dependencies-original-installation.rst
  getting-started/pytorch/index2.rst
  getting-started/tensorflow/index2.rst

  
.. toctree::
  :caption: Scripts and Templates (Original Cerebras Installation Only)
  :maxdepth: 2
  :hidden:

  getting-started/pytorch/run-py-template.rst
  getting-started/pytorch/csrun-cpu.rst
  getting-started/pytorch/csrun-wse.rst
  getting-started/tensorflow/cs_input_analyzer.rst

.. toctree::
  :maxdepth: 2
  :caption: Reference Samples
  :hidden:

  Cerebras Model Zoo <https://github.com/Cerebras/modelzoo/tree/master/modelzoo>
  reference-samples/gpu-requirements.rst

.. toctree::
  :maxdepth: 2
  :caption: Cerebras Advanced
  :hidden:

  general/dataloader/index.rst
  general/cs-1-data-formats.rst
  general/dynamic-loss-scaling.rst
  general/performance-optimization.rst
  general/multi-replica-data-parallel-training.rst
  general/sparsity.rst
  general/checkpoint-formats.rst
  

.. toctree::
  :maxdepth: 2
  :caption: Develop with TensorFlow (Pipelined Mode Only)
  :hidden:

  tensorflow-docs/cs-tf-workflow.rst
  tensorflow-docs/porting-tf-to-cs/index.rst
  tensorflow-docs/preparing-tf-input/index.rst
  tensorflow-docs/tf-dynamic-loss-scaling.rst
  tensorflow-docs/compile-on-cpu/validate-and-compile-on-cpu.rst
  tensorflow-docs/running-a-model/train-eval-predict.rst
  tensorflow-docs/early-stopping.rst
  tensorflow-docs/multiple-models/index.rst
  tensorflow-docs/tf-vsl.rst
  tensorflow-docs/tuning-tf-for-cs/using-tensorboard.rst
  tensorflow-docs/tuning-tf-for-cs/best-practices-tf.rst
  tensorflow-docs/tf-layers/index.rst


.. toctree::
  :maxdepth: 2
  :caption: Develop with PyTorch (Pipelined Mode Only)
  :hidden:

  pytorch-docs/pytorch-cs-workflow.rst
  pytorch-docs/adapting-pytorch-to-cs.rst
  pytorch-docs/pytorch-checkpointing.rst
  pytorch-docs/pytorch-custom-runner.rst
  pytorch-docs/pytorch-vts.rst
  pytorch-docs/cbtorch-limitations.rst
  pytorch-docs/pytorch-ops/index.rst

.. toctree::
  :maxdepth: 2
  :caption: Compiler Reports (Pipelined Mode Only)
  :hidden:

  compiler-reports/input-function-report.rst
  compiler-reports/compile-report.rst
  compiler-reports/incremental-compile.rst


.. toctree::
  :caption: Extensions (Original Cerebras Installation Only)
  :maxdepth: 2
  :hidden:

  software-guides/adding-custom-pkgs-to-cbcore-container.rst