# Welcome to TFHE-rs

TFHE-rs is a pure Rust implementation of TFHE for Boolean and integer arithmetics over encrypted data. It includes a Rust and C API, as well as a client-side WASM API.

TFHE-rs also includes a [GPU accelerated backend](https://docs.zama.org/tfhe-rs/1.3/hardware-acceleration/run-on-gpu) as well as an [HPU accelerated backend](https://docs.zama.org/tfhe-rs/1.3/hardware-acceleration/run-on-hpu).

## Get started

Learn the basics of TFHE-rs, set it up, and make it run with ease.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>What is TFHE-rs?</strong></td><td>Understand TFHE-rs library and basic cryptographic concepts</td><td><a href="get-started/getting-started">getting-started</a></td><td><a href="https://298266411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkMvc1zsbZF9WUe7AqHFM%2Fuploads%2Fgit-blob-ef8d6303f852601e203cdfd9fa6bbdd4a47d8c96%2Fstart1.png?alt=media">start1.png</a></td></tr><tr><td><strong>Installation</strong></td><td>Follow the step by step guide to import TFHE-rs in your project</td><td><a href="get-started/installation">installation</a></td><td><a href="https://298266411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkMvc1zsbZF9WUe7AqHFM%2Fuploads%2Fgit-blob-794ee2f6e7160affe67c2b1aca1caae1559c9537%2Fstart2.png?alt=media">start2.png</a></td></tr><tr><td><strong>Quick start</strong></td><td>See a full example of using TFHE-rs to compute on encrypted data</td><td><a href="get-started/quick-start">quick-start</a></td><td><a href="https://298266411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkMvc1zsbZF9WUe7AqHFM%2Fuploads%2Fgit-blob-84e7b26136ae0010e6a313fb6432333cbc23d281%2Fstart3.png?alt=media">start3.png</a></td></tr></tbody></table>

## Build with TFHE-rs

Start building with TFHE-rs by exploring its core features, discovering essential guides, and learning more with user-friendly tutorials.

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>FHE Computations</strong></td><td>Run FHE computation on encrypted data.</td><td><ul><li><a href="fhe-computation/types">Types</a></li><li><a href="fhe-computation/operations">Operations</a></li></ul></td><td><a href="https://298266411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkMvc1zsbZF9WUe7AqHFM%2Fuploads%2Fgit-blob-db74dbcb555ece9e55db2fb1f46865afda731ccf%2Fbuild1.png?alt=media">build1.png</a></td></tr><tr><td><strong>Configuration</strong></td><td>Advanced configuration for better performance.</td><td><ul><li><a href="configuration/rust-configuration">Advanced Rust</a></li><li><a href="hardware-acceleration/run-on-gpu">GPU acceleration</a></li><li><a href="hardware-acceleration/run-on-hpu">HPU acceleration</a></li></ul></td><td><a href="https://298266411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkMvc1zsbZF9WUe7AqHFM%2Fuploads%2Fgit-blob-b73fb94c4da0baf0663f79c74e67fc243cb2ed18%2Fbuild2.png?alt=media">build2.png</a></td></tr><tr><td><strong>Integration</strong></td><td>Use TFHE-rs in different contexts or platforms..</td><td><ul><li><a href="integration/c-api">C API</a></li><li><a href="integration/js-on-wasm-api">JS on WASM API</a></li></ul></td><td><a href="https://298266411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkMvc1zsbZF9WUe7AqHFM%2Fuploads%2Fgit-blob-07fea976044a7544d615347d2511116027127eba%2Fbuild3.png?alt=media">build3.png</a></td></tr></tbody></table>

## Explore more

Access to additional resources and join the Zama community.

### Tutorials

Explore step-by-step guides that walk you through real-world uses of TFHE-rs.

* [Homomorphic parity bit](https://docs.zama.org/tfhe-rs/1.3/tutorials/parity-bit): Learn how to implement a parity bit calculation over encrypted data
* [Homomorphic case changing on ASCII string](https://docs.zama.org/tfhe-rs/1.3/tutorials/ascii-fhe-string): See how to process string data securely by changing cases while keeping the data encrypted.
* [SHA256 with Boolean API](https://docs.zama.org/tfhe-rs/1.3/tutorials/sha256-bool): Delve into a more complex example: implementing the SHA256 hash function entirely on encrypted boolean values.
* [All tutorials](https://docs.zama.org/tfhe-rs/1.3/tutorials/see-all-tutorials): A complete list of all available tutorials in one place.tutorials: A complete list of all available tutorials in one place.

### References & Explanations

Take a deep dive into TFHE-rs, exploring APIs from the highest to the lowest level of abstraction and accessing additional resources for in-depth explanations.

* [Rust API reference](https://docs.rs/tfhe/latest/tfhe/): High-level API that abstracts cryptographic complexities and simplifies the development and more
* [Fine-grained APIs](https://docs.zama.org/tfhe-rs/1.3/references/fine-grained-apis): Mid-level APIs that enable evaluation of Boolean, short integer, and integer circuits
* [Core crypto API](https://docs.zama.org/tfhe-rs/1.3/references/core-crypto-api): Low-level API with the primitive functions and types of the TFHE scheme
* [TFHE deep dive](https://docs.zama.org/tfhe-rs/1.3/explanations/tfhe-deep-dive): Resources that explain the Fully Homomorphic Encryption scheme - TFHE
* [TFHE-rs handbook](https://github.com/zama-ai/tfhe-rs-handbook): Document describing algorithms implemented in TFHE-rs

### Support channels

Ask technical questions and discuss with the community. Our team of experts usually answers within 24 hours during working days.

* [Community forum](https://community.zama.ai/)
* [Discord channel](https://discord.com/invite/fhe-org)

### Developers

Collaborate with us to advance the FHE spaces and drive innovation together.

* [Contribute to TFHE-rs](https://docs.zama.org/tfhe-rs/1.3/developers/contributing)
* [Check the latest release note](https://github.com/zama-ai/tfhe-rs/releases)
* [Request a feature](https://github.com/zama-ai/tfhe-rs/issues/new?assignees=\&labels=feature_request\&projects=\&template=feature_request.md\&title=)
* [Report a bug](https://github.com/zama-ai/tfhe-rs/issues/new?assignees=\&labels=triage_required\&projects=\&template=bug_report.md\&title=)

***