Habana® Gaudi® v1.1 Documentation¶
Major updates to the documents are summarized in Documentation Updates.
Before you Get Started: Be sure to read the Release Notes before installing or upgrading to 1.1.x to learn about new features and limitations.
Support Matrix - Details the configurations and versions supported for each release.
Gaudi Architecture and Software Overview - Describes Gaudi architecture and the SynapseAI software suite.
Best Practices for Model Training with Gaudi - Describes how to get the most benefit out of Habana Gaudi.
Release Notes - Release Notes for Gaudi SynapseAI features and limitations.
Installation Guide - Describes how to obtain and install the SynapseAI software package and the TensorFlow software package.
Gaudi Migration Guide - Guides users porting their own TensorFlow or PyTorch models to the Gaudi HPU.
SynapseAI User Guides¶
TensorFlow User Guide - Provides guidelines on how to modify existing models to run on TensorFlow platform.
PyTorch User Guide - Provides guidelines on how to modify existing models to run on PyTorch platform.
Distributed Training with TensorFlow - Provides guidelines on how to run distributed training using Gaudi.
Qualification Library Guide - Provides information on the Habana Labs Qualification Tool (hl_qual) for Gaudi.
Profiler User Guide - Provides information about the SynapseAI Profiling Subsystem.
System Management Interface Tool User Guide - Describes the system management interface tool.
Debugging Guide - Provides recommendations and tips for debugging model functionality and performance.
Model Performance Optimization Guide - Provides multiple methods that can be implemented in order to achieve the best performance using the Habana Gaudi accelerator for your training models.
Kubernetes User Guide - Describes the steps to setup a generic Kubernetes solution.
AWS Quick Start Guide¶
Habana Base AMI - Provides guides and instructions for how to set up a Habana Deep Learning AMI on Amazon EC2 services, and provides release notes for the Habana image.
AWS Distributed Quick Start Training - Describes how to run distributed training workloads on multiple DL1 Instances for AWS users.
AWS Software Update for Habana - Describes how to manage the Habana SynapseAI® software suite upgrades on AWS DL1 instances.
TPC User Guides¶
TPC Tools Installation Guide - Provides installation instructions for the TPC-C compiler, assembler, dis-assembler and all necessary headers.
TPC User Guide - Getting started guide for TPC code development.
TPC Tools Debugger - Provides TPC debugger installation and usage instructions.
TPC Intrinsics Guide - Provides TPC Intrinsics introduction and reference to the header in GitHub.
API Reference Guides¶
Habana Communication Library (HCL) API Reference - Provides the list of Habana Communication Library APIs.
Habana Collective Communications Library (HCCL) API Reference - Provides the list of Habana Collective Communication Library APIs.
Habana Labs Management Library (HLML) API Reference - Provides the list of APIs for monitoring and managing various states within Habana Labs’ AI accelerators.
TensorFlow CustomOp API Reference - Describes APIs exposed to write custom TensorFlow Operators for the Habana Accelerator.