taichi README

The project's README from github.com/taichi-dev/taichi. As one markdown file: README.md.


Latest Release downloads CI Nightly Release discord invitation link

pip install taichi  # Install Taichi Lang
ti gallery          # Launch demo gallery

What is Taichi Lang?

Taichi Lang is an open-source, imperative, parallel programming language for high-performance numerical computation. It is embedded in Python and uses just-in-time (JIT) compiler frameworks, for example LLVM, to offload the compute-intensive Python code to the native GPU or CPU instructions.

The language has broad applications spanning real-time physical simulation, numerical computation, augmented reality, artificial intelligence, vision and robotics, visual effects in films and games, general-purpose computing, and much more.

...More

Why Taichi Lang?

Getting Started

Installation

Prerequisites
  • Operating systems
    • Windows
    • Linux
    • macOS
  • Python: 3.6 ~ 3.10 (64-bit only)
  • Compute backends
    • x64/ARM CPUs
    • CUDA
    • Vulkan
    • OpenGL (4.3+)
    • Apple Metal
    • WebAssembly (experiemental)

Use Python's package installer pip to install Taichi Lang:

pip install --upgrade taichi

We also provide a nightly package. Note that nightly packages may crash because they are not fully tested. We cannot guarantee their validity, and you are at your own risk trying out our latest, untested features. The nightly packages can be installed from our self-hosted PyPI (Using self-hosted PyPI allows us to provide more frequent releases over a longer period of time)

pip install -i https://pypi.taichi.graphics/simple/ taichi-nightly

Run your "Hello, world!"

Here is how you can program a 2D fractal in Taichi:

# python/taichi/examples/simulation/fractal.py

import taichi as ti

ti.init(arch=ti.gpu)

n = 320
pixels = ti.field(dtype=float, shape=(n * 2, n))


@ti.func
def complex_sqr(z):
    return ti.Vector([z[0]**2 - z[1]**2, z[1] * z[0] * 2])


@ti.kernel
def paint(t: float):
    for i, j in pixels:  # Parallelized over all pixels
        c = ti.Vector([-0.8, ti.cos(t) * 0.2])
        z = ti.Vector([i / n - 1, j / n - 0.5]) * 2
        iterations = 0
        while z.norm() < 20 and iterations < 50:
            z = complex_sqr(z) + c
            iterations += 1
        pixels[i, j] = 1 - iterations * 0.02


gui = ti.GUI("Julia Set", res=(n * 2, n))

for i in range(1000000):
    paint(i * 0.03)
    gui.set_image(pixels)
    gui.show()

If Taichi Lang is properly installed, you should get the animation below 🎉:

See Get started for more information.

Build from source

If you wish to try our experimental features or build Taichi Lang for your own environments, see Developer installation.

Documentation

Community activity Time period

Timeline graph Issue status graph Pull request status graph Trending topics

Contributing

Kudos to all of our amazing contributors! Taichi Lang thrives through open-source. In that spirit, we welcome all kinds of contributions from the community. If you would like to participate, check out the Contribution Guidelines first.

Contributor avatars are randomly shuffled.

License

Taichi Lang is distributed under the terms of Apache License (Version 2.0).

See Apache License for details.

Community

For more information about the events or community, please refer to this page

Join our discussions

Report an issue

Contact us

Reference

Demos

AOT deployment

Lectures & talks

Citations

If you use Taichi Lang in your research, please cite the corresponding papers:

taichi (taichi-dev/taichi)

scientific-computing
Searching Database…

28.4K ·GitHub
What is this?Taichi Lang is an open-source language for high-performance GPU programming embedded in Python: you write Python-like code and its JIT compiler turns it into efficient parallel GPU or CPU machine code.
Is it a Python library or its own language?Both, in a way: it's a separate language that lives inside Python — it shares almost the same syntax and integrates with NumPy and PyTorch, while the compiler itself is written in C++.
Do I need an NVIDIA GPU to run it?No — plain x64 and ARM CPUs work too. For GPU acceleration Taichi supports most mainstream APIs: CUDA, Vulkan, OpenGL 4.3+, and Apple Metal. WebAssembly support is experimental.
Any gotchas before I try it?Python support stops at 3.10 (64-bit only), and the nightly package may crash because it is not fully tested. Quantized computation and WebAssembly are still experimental.
Who is it for — is it a graphics thing or an AI thing?Mostly compute-heavy work: real-time physical simulation, numerical computation, augmented reality, AI, vision and robotics, and visual effects in films and games, plus general-purpose parallel computing.
What are SNodes and why would I care?SNodes are Taichi's generic data containers for composing hierarchical, multi-dimensional fields — the mechanism behind spatially sparse computing, which matters for large numerical simulations.
Does it support differentiable programming?Yes, it's one of the headline features: kernels can produce gradients, which DiffTaichi uses for differentiable physical simulation and optimization in machine learning research.
Where can I see examples or learn it?The README links Taichi Lang examples and advanced examples plus an Awesome Taichi list, and there are lectures: a SIGGRAPH 2020 course on YouTube and Bilibili and the GAMES 201 advanced physics engine course.
Can Taichi code run outside Python?Yes — there are AOT (ahead-of-time) deployment demos and a tutorial for running compiled kernels beyond the Python runtime.
What are similar projects?Open3D, numba, DLSS5-Feeder, crosstl, bgfx, taskflow, renderdoc, filament
Creator
taichi-dev
Size
58.9 MB
Stars
28.4K
Age
9y
Commits · 90 Days