Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: cleanup(fix typo & grammar correction) the documents. #955

Open
osrm opened this issue Dec 9, 2024 · 0 comments
Open

docs: cleanup(fix typo & grammar correction) the documents. #955

osrm opened this issue Dec 9, 2024 · 0 comments

Comments

@osrm
Copy link

osrm commented Dec 9, 2024

Summary

Fix typos and grammar correction in documents. Hope this helps!

Changes

  1. Let's use following conventions for the docs. If a new convention needs to be decided, let's agree and then add it here.

"Let's use following conventions for the docs." -> "Let's use the following conventions for the docs."

Reason: The phrase "the following" is a fixed expression, and it requires the definite article "the" before "following" to be grammatically correct. Therefore, "Let's use the following conventions..." is the correct expression.

  1. 1. Variables names should use ticks: `variable_name` or `variable_name=10.5`

"Variables names should use ticks:" -> "Variable names should use ticks:"

Reason: The term "Variable" should be singular to agree with "names" which is plural. Therefore, "Variable names should use ticks:" is the correct expression.

  1. Concrete ML support compiling both built-in and custom models using a CUDA-accelerated backend. However, once

"Concrete ML support compiling both built-in and custom models using a CUDA-accelerated backend." -> "Concrete ML supports compiling both built-in and custom models using a CUDA-accelerated backend."

Reason: "Concrete ML" is a singular noun, so the verb "support" should be in its singular form "supports" to be grammatically correct.

  1. When compared to a high-end server CPUs(64-core or 96-core), the speed-up is typically around 1x to 3x.

"When compared to a high-end server CPUs(64-core or 96-core), the speed-up is typically around 1x to 3x." -> "When compared to high-end server CPUs (64-core or 96-core), the speed-up is typically around 1x to 3x."

Reason: "a high-end server CPUs" is incorrect because it uses the singular article "a" with the plural noun "CPUs." The correct phrase should be "high-end server CPUs" without the article "a."

  1. When building a full neural network, each layer will contain multiple neurons, which are connected to the inputs or to the neuron outputs of a previous layer.

"outputs of a previous layer" -> "outputs of the previous layer"

Reason: The definite article "the" should be used before "previous layer" to specify that it is referring to a specific previous layer.

  1. This document illustrate how Concrete ML model and DataFrames are deployed in client/server setting when creating privacy-preserving services in the cloud.

"This document illustrate how Concrete ML model and DataFrames" -> "This document illustrates how Concrete ML model and DataFrames"

Reason: The verb "illustrate" should be in its singular form "illustrates" to agree with the singular subject "This document."

  1. Once compiled to FHE, a Concrete ML model or DataFrame generates machine code that execute prediction, training or pre-processing on encrypted data. During this process, Concrete ML generates [the private encryption keys](concepts.md#cryptography-concepts) and [the pubic evaluation keys](concepts.md#cryptography-concepts).

"execute prediction, training or pre-processing on encrypted data" -> "executes prediction, training, or pre-processing on encrypted data"

Reason: The verb "execute" should be in its singular form "executes" to agree with the singular subject "machine code."

  1. Once compiled to FHE, a Concrete ML model or DataFrame generates machine code that execute prediction, training or pre-processing on encrypted data. During this process, Concrete ML generates [the private encryption keys](concepts.md#cryptography-concepts) and [the pubic evaluation keys](concepts.md#cryptography-concepts).

"pubic evaluation keys" -> "public evaluation keys"

Reason: The correct term is "public evaluation keys," not "pubic evaluation keys."

  1. The `n_bits` parameter controls the bit-width of the inputs and weights of the linear models. Linear models do not use table lookups and thus alllows weight and inputs to be high precision integers.

"alllows" -> "allows"

Reason: There is a typographical error; "allows" is the correct spelling.

  1. The trainable logistic model uses Stochastic Gradient Descent (SGD) and quantizes the data, weights, gradients and the error measure. It currently supports training 6-bit models, including g both the coefficients and the bias.

"including g both the coefficients and the bias" -> "including both the coefficients and the bias"

Reason: The "g" is a typographical error and should be removed. (* I know this is an article about SGD Logistic Regression. If the including ‘g’ stands for Gradient or Gravity, it would be nice if it was corrected instead of deleted.)

  1. Once you have tested an `SGDClassifier` that trains on encrypted data, you can build an FHE training service by deploying the FHE training program of the `SGDClassifier`. See the [Production Deloyment](../guides/client_server.md) page for more details on how to the Concrete ML deployment utility classes. To deploy an FHE training program, you must pass the `mode='training'` parameter to the `FHEModelDev` class.

"Production Deloyment" -> "Production Deployment"

Reason: "Deloyment" is a typographical error, and the correct term is "Deployment."

  1. - **Programmable Boostrapping (PBS)** : Programmable Bootstrapping enables the homomorphic evaluation of any function of a ciphertext, with a controlled level of noise. Learn more about PBS in [this paper](https://eprint.iacr.org/2021/091).

    For a deeper understanding of the cryptography behind the Concrete stack, refer to the [whitepaper on TFHE and Programmable Boostrapping](https://whitepaper.zama.ai/) or [this series of blogs](https://www.zama.ai/post/tfhe-deep-dive-part-1).

"Programmable Boostrapping (PBS)" -> "Programmable Bootstrapping (PBS)"

Reason: "Boostrapping" is a typographical error, and the correct term is "Bootstrapping."

@osrm osrm changed the title Docs: Cleanup(Fix typo & Grammar correction) the documents. docs: cleanup(fix typo & grammar correction) the documents. Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant