Skip to content

Commit

Permalink
docs(frontend): fix broken links
Browse files Browse the repository at this point in the history
and ignore those that cant be automatically checked (sadly)
  • Loading branch information
aquint-zama authored and rudy-6-4 committed Oct 27, 2023
1 parent a47d766 commit 8595aad
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 18 deletions.
2 changes: 1 addition & 1 deletion backends/concrete-cpu/implementation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In order to be integrated in a C-based project like the `concrete-compiler` runt

### Prerequisites

The `concrete-cpu` project is implemented thanks Rust, thus as the main prerequiste the rust toolchain must be installed. You can install from the official (Install Rust instructions)[https://www.rust-lang.org/tools/install]. Some of features like the use of avx512 instructions are available only with a nightly rust toolchain so if you want to use it you need to install it following those (instructions)[https://rust-lang.github.io/rustup/concepts/channels.html].
The `concrete-cpu` project is implemented thanks Rust, thus as the main prerequiste the rust toolchain must be installed. You can install from the official [Install Rust instructions](https://www.rust-lang.org/tools/install). Some of features like the use of avx512 instructions are available only with a nightly rust toolchain so if you want to use it you need to install it following those [instructions](https://rust-lang.github.io/rustup/concepts/channels.html).

### Setting RUSTFLAGS

Expand Down
8 changes: 4 additions & 4 deletions backends/concrete-cuda/implementation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Concrete-cuda holds the code for GPU acceleration of Zama's variant of TFHE.
It is one of the backends of the Concrete Compiler.
It implements CUDA/C++ functions to perform homomorphic operations on LWE ciphertexts.

It provides functions to allocate memory on the GPU, to copy data back
It provides functions to allocate memory on the GPU, to copy data back
and forth between the CPU and the GPU, to create and destroy Cuda streams, etc.:
- `cuda_create_stream`, `cuda_destroy_stream`
- `cuda_malloc`, `cuda_check_valid_malloc`
Expand All @@ -22,16 +22,16 @@ The cryptographic operations it provides are:

## Dependencies

**Disclaimer**: Compilation on Windows/Mac is not supported yet. Only Nvidia GPUs are supported.

**Disclaimer**: Compilation on Windows/Mac is not supported yet. Only Nvidia GPUs are supported.
<!-- markdown-link-check-disable-next-line -->
- nvidia driver - for example, if you're running Ubuntu 20.04 check this [page](https://linuxconfig.org/how-to-install-the-nvidia-drivers-on-ubuntu-20-04-focal-fossa-linux) for installation
- [nvcc](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html) >= 10.0
- [gcc](https://gcc.gnu.org/) >= 8.0 - check this [page](https://gist.github.com/ax3l/9489132) for more details about nvcc/gcc compatible versions
- [cmake](https://cmake.org/) >= 3.24

## Build

The Cuda project held in `concrete-cuda` can be compiled independently from Concrete in the
The Cuda project held in `concrete-cuda` can be compiled independently from Concrete in the
following way:
```
git clone git@github.com:zama-ai/concrete
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# test_concrete_cuda

This test tool is written over GoogleTest library. It tests the correctness of the concrete framework's CUDA-accelerated functions and helps identify arithmetic flaws.
The output format can be adjusted according to the user's interest.
This test tool is written over GoogleTest library. It tests the correctness of the concrete framework's CUDA-accelerated functions and helps identify arithmetic flaws.
The output format can be adjusted according to the user's interest.

A particular function will be executed for each test case, and the result will be verified considering the expected behavior. This will be repeated for multiple encryption keys and samples per key. These can be modified by changing `REPETITIONS` and `SAMPLES` variables at the beginning of each test file.

## How to Compile

The first step in compiling code with CMake is to create a build directory. This directory will
contain all the files generated during the build process, such as object files and executables.
We recommend creating this directory outside of the source directory, but inside the
The first step in compiling code with CMake is to create a build directory. This directory will
contain all the files generated during the build process, such as object files and executables.
We recommend creating this directory outside of the source directory, but inside the
implementation folder, to keep the source directory clean.

```bash
Expand Down Expand Up @@ -40,7 +40,7 @@ This will run all the available tests.

## How to Filter Tests

You can select a subset of sets by specifying a filter for the name of the tests of interest as
You can select a subset of sets by specifying a filter for the name of the tests of interest as
an argument. Only tests whose full name matches the filter will be executed.

For example, to run only tests whose name starts with the word "Bootstrap", you can execute:
Expand All @@ -49,12 +49,12 @@ For example, to run only tests whose name starts with the word "Bootstrap", you
$ test_and_benchmark/test/test_concrete_cuda --gtest_filter=Bootstrap*
```

The parameter `--gtest_list_tests` can be used to list all the available tests, and a better
The parameter `--gtest_list_tests` can be used to list all the available tests, and a better
description on how to select a subset of tests can be found in
[GoogleTest documentation](http://google.github.io/googletest/advanced.html#running-a-subset-of-the-tests).

## Conclusion

With these options, you can easily verify the correctness of concrete-cuda's implementations. If
With these options, you can easily verify the correctness of concrete-cuda's implementations. If
you have any questions or issues, please feel free to contact us.
To learn more about GoogleTest library, please refer to the [official user guide](http://google.github.io/googletest/).
To learn more about GoogleTest library, please refer to the [official user guide](http://google.github.io/googletest/).
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ This documentation is split into several sections:

* Support forum: [https://community.zama.ai](https://community.zama.ai) (we answer in less than 24 hours).
* Live discussion on the FHE.org discord server: [https://discord.fhe.org](https://discord.fhe.org) (inside the #**concrete** channel).
* Do you have a question about Zama? Write us on [Twitter](https://twitter.com/zama\_fhe) or send us an email at: **hello@zama.ai**
<!-- markdown-link-check-disable-next-line -->
* Do you have a question about Zama? Write us on [Twitter](https://twitter.com/zama_fhe) or send us an email at: **hello@zama.ai**

## How is Concrete different from Concrete Numpy?

Expand Down
2 changes: 1 addition & 1 deletion docs/application-tutorial/game_of_life.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

In the associated [Python file](https://github.com/zama-ai/concrete/blob/main/frontends/concrete-python/examples/game_of_life/game_of_life.py), you can run the Game of Life, written in Concrete Python.

![ Game of Life](../_static/game_of_life.gif)
![ Game of Life](../_static/game-of-life.gif)

### Installation

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Some of these operations are not supported between two encrypted values. A detai
* [np.reshape](https://numpy.org/doc/stable/reference/generated/numpy.reshape.html)
* [np.right\_shift](https://numpy.org/doc/stable/reference/generated/numpy.right\_shift.html)
* [np.rint](https://numpy.org/doc/stable/reference/generated/numpy.rint.html)
* [np.round\_](https://numpy.org/doc/stable/reference/generated/numpy.round\_.html)
* [np.round](https://numpy.org/doc/stable/reference/generated/numpy.round.html)
* [np.sign](https://numpy.org/doc/stable/reference/generated/numpy.sign.html)
* [np.signbit](https://numpy.org/doc/stable/reference/generated/numpy.signbit.html)
* [np.sin](https://numpy.org/doc/stable/reference/generated/numpy.sin.html)
Expand Down
2 changes: 1 addition & 1 deletion docs/howto/call_from_other_language.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ After doing a compilation, we endup with a couple of artifacts, including crypto
`bindgen` is used to generate Rust FFI bindings to the CAPI
[The Rust bindings](https://github.com/zama-ai/concrete/tree/main/compilers/concrete-compiler/compiler/lib/Bindings/Rust) are built on top of the CAPI in order to provide a safer, and more Rusty API. Although you can use `bindgen` (as we did to build the Rust bindings) to generate the Rust FFI from the CAPI and use it as is, we will here show how to use the Rust API that is built on top of that, as it's easier to use.

![](../\_static/calling\_from\_other\_lang\_rust\_bindings.jpg)
![](../_static/calling_from_other_lang_rust_bindings.jpg)


### Demo
Expand Down

0 comments on commit 8595aad

Please sign in to comment.