Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
nvukobratTT committed Aug 21, 2024
1 parent 3ee6122 commit e157b41
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 4 deletions.
9 changes: 6 additions & 3 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Summary

[Introduction](./introduction.md)
# Introduction
- [Introduction](./introduction.md)

# User Guide
# Project setup
- [Building](./build.md)

- [Building](./build.md)
# User Guide
- [Getting Started](./getting-started.md)
38 changes: 38 additions & 0 deletions docs/src/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Building

Following page describes how to build the project on your local machine.

## Prerequisites
Main project dependencies are:
1. Clang 17
1. Ninja
1. CMake 3.20 or higher
1. Git LFS
1. Python 3.10 or higher

On Ubuntu 22.04 systems, you can install these dependencies using the following commands:
```sh
# Update package list
sudo apt update -y
sudo apt upgrade -y

# Install Clang
sudo apt install clang-17

# Install Ninja
sudo apt install ninja-build

# Install CMake
sudo apt remove cmake -y
pip3 install cmake --upgrade
cmake --version

# Install Git LFS
sudo apt install git-lfs

# Check Python version
python3 --version
```

## Build environment
Environment is built only once, and it setups Python venv, TT-MLIR, LLVM, and other dependencies.
Empty file added docs/src/getting-started.md
Empty file.
2 changes: 1 addition & 1 deletion docs/src/introduction.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### Introduction
# Introduction

The **TT-Forge FE** is a graph compiler designed to optimize and transform computational graphs for deep learning models, enhancing their performance and efficiency.

Expand Down

0 comments on commit e157b41

Please sign in to comment.