diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 4d92159f3..bb4b4de8a 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -258,7 +258,8 @@ Test the newly implemented features locally by following instructions in the [Co Once you have added a minimum number of content to your branch, you can create a [draft PR](https://github.blog/2019-02-14-introducing-draft-pull-requests/). Create a pull request to merge your branch (e.g., `202-train-bug-nacho`) into the `develop` branch. `develop` should always be functional and up to date with new working features. It is the equivalent of the `main`or `master` branch in DISCO. It is important to give a good description to your PR as this makes it easier for other people to go through it. -> [!TIP] > [This PR](https://github.com/epfml/disco/pull/176) is a good example. +> [!TIP] +> [This PR](https://github.com/epfml/disco/pull/176) is a good example. ### 5. Before requesting a review diff --git a/docs/PRIVACY.md b/docs/PRIVACY.md index d1e6a5d61..09df80c01 100644 --- a/docs/PRIVACY.md +++ b/docs/PRIVACY.md @@ -19,7 +19,7 @@ Differential privacy (DP) is a rigorous privacy framework that provides a privac In DISCO, differential privacy ensures privacy by making sure that the weight updates produced by one client do not significantly change when a single data point in that client's dataset is modified. This is called local differential privacy (LDP). Before sharing weight updates with the server, random noise is added to these updates. By examining only the weight updates that each client sends to the server, no party, including the server, can infer who generated a specific update or which datasets particular clients have. -Differntial privacy has an important parameter, epsilon($\epsilon$), which indicates the privacy level applied to the learning process. It is also called the "privacy budget." +Differential privacy has an key parameter, epsilon($\epsilon$), which indicates the privacy level applied to the learning process. It is also called the "privacy budget." ### Parameter Explanations Differential privacy is achieved by adding noise. To guarantee your desired privacy level, you need to specify several parameters: diff --git a/docs/VUEJS.md b/docs/VUEJS.md index dea753d61..6bdfb2ebe 100644 --- a/docs/VUEJS.md +++ b/docs/VUEJS.md @@ -61,7 +61,7 @@ See [Naming convention section](#naming-conventions) for more information. ### `Container` directory -The `container` directory holds all `vue` components that fulfil a container function. In other words, most components in this folder make extensive use of the [slot `vue` construct](https://v3.vuejs.org/guide/component-slots.html) +The `container` directory holds all `vue` components that fulfill a container function. In other words, most components in this folder make extensive use of the [slot `vue` construct](https://v3.vuejs.org/guide/component-slots.html) ```html