.. _cerebras-docs: Explore the Documentation ========================= .. raw:: html

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.

Learn Cerebras basics

How Cerebras works How Cerebras works

Start by learning the basics about how Cerebras systems are deployed and used.

Cerebras installations

Cerebras offers two forms of deployment for CS systems, Wafer-Scale clusters and Original Cerebras installations. Which one do you have?

Cerebras Software Platform

The Cerebras Graph Compiler (CGC) compiles your ML code into a binary for execution on a CS system.

Pipelined and Weight Streaming execution

Cerebras Software Platform supports two execution modes on CS systems.

Types of CS systems installations in more details Types of installations

Learn about Wafer-Scale cluster and Original Cerebras installation and what execution modes are supported by them.

Execution modes in more details Pipelined and Weight Streaming modes

How Pipelined and Weight Streaming work.

ML workflow on Cerebras Cerebras ML workflow

Whether your framework is TensorFlow or PyTorch, get to know the general ML workflow on Cerebras first.

Quickstarts

Quickstarts for Wafer-Scale Cluster
Quickstarts for Original Cerebras Installation

Check out the reference models

Reference code Cerebras Model Zoo Reference Models

GitHub repo with a partial list of various neural network models currently supported.

Start developing

Dive into developing with TensorFlow and PyTorch

PyTorch or TensorFlow, we got you covered. Start your framework-to-CS journey here.

Optimize your ML code Performance optimization practices

Determine optimal Slurm resources, use the compiler report to enhance input function.

Extensions

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 `_. .. 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 getting-started/job-scheduler.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: Model Zoo Repository :hidden: reference-samples/modelzoo.rst 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