github/concrete
1
1
Fork 0
mirror of https://github.com/zama-ai/concrete.git synced 2026-04-17 03:00:54 -04:00
Code Issues Packages Projects Releases Wiki Activity

doc(getting-started-guide): add getting started guide to sphinx toc and readme.md, fix branch convention, improve wording

Browse Source
This commit is contained in:
Umut
2021-08-05 18:06:48 +03:00
parent ebce33327d
commit 4b1990e731
3 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -1,4 +1,5 @@
# hdk
Homomorphic Development Framework - collection of tools to FHE all the things
Developers can take a look at [ARCHITECTURE.md](docs/dev/ARCHITECTURE.md)
Developers can take a look at [ARCHITECTURE.md](docs/dev/ARCHITECTURE.md) to get the bigger picture and [GETTING-STARTED.md](docs/dev/GETTING-STARTED.md) to start developing.

7
docs/dev/GETTING-STARTED.md
View File

@@ -65,8 +65,7 @@ In this section we will go over some terms that we use throughout the project.
- a data structure to represent a calculation
- basically a computation graph where nodes are either inputs or operations on other nodes
- tracing
- act of creating intermediate representation from plain python functions
- this is awesome to have to avoid manual intermediate representation creation
- it is our technique to take directly a plain numpy function from a user and deduce its intermediate representation in a painless way for the user
- bounds
- before intermediate representation is sent to the compiler, we need to know which node will output which type (e.g., uint3 vs uint5)
- there are several ways to do this but the simplest one is to evaluate the intermediate representation with all combinations of inputs and remember the maximum and the minimum values for each node, which is what we call bounds, and bounds can be used to determine the appropriate type for each node
@@ -93,13 +92,13 @@ Now, you have a working environment, and you know what is where in the project.
We are using a consistent branch naming scheme, and you are expected to follow it as well. Here is the format and some examples.
```shell
git checkout -b {feat|fix|refactor|test|benchmark|doc|style|chore}/short-description{_$issue_id}?
git checkout -b {feat|fix|refactor|test|benchmark|doc|style|chore}/short-description_$issue_id
```
e.g.
```shell
git checkout -b feat/explicit-tlu
git checkout -b feat/explicit-tlu_11
git checkout -b fix/tracing_indexing_42
```

3
docs/index.rst
View File

@@ -6,4 +6,5 @@ Homomorphic Development Kit's documentation
:maxdepth: 2
:caption: Developer docs
dev/ARCHITECTURE.md
dev/ARCHITECTURE.md
dev/GETTING-STARTED.md