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

fix: typos in documentation files #126

Merged
merged 7 commits into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/aivm.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ Custom models must meet these requirements:

### Next Steps

Now you can check out the [examples](https://github.com/NillionNetwork/nillion-aivm/tree/main/examples) folder and get started with your own fine-tuned nd custom models.
Now you can check out the [examples](https://github.com/NillionNetwork/nillion-aivm/tree/main/examples) folder and get started with your own fine-tuned and custom models.

You can try:

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

👋 Hey, welcome to [Nillion](https://docs.nillion.com/).

This page will help you take your first steps (~30 mins) as a Nillion developer. Once you have completed them, fill out the form for your chance to claim your $20 prize - each week we will review the submissions and pick the best to recieve a prize 🎉
This page will help you take your first steps (~30 mins) as a Nillion developer. Once you have completed them, fill out the form for your chance to claim your $20 prize - each week we will review the submissions and pick the best to receive a prize 🎉

1. Star & fork either the [Python](https://github.com/NillionNetwork/nillion-python-starter) or [JavaScript](https://github.com/NillionNetwork/cra-nillion) quickstart repos (bonus points for both)

Expand Down
2 changes: 1 addition & 1 deletion docs/nada-lang-programs.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The [`tiny_addition.py`](https://github.com/nillion-oss/nillion-python-starter/b

<table><thead><tr><th width="162">Input name</th><th width="145">Input type</th><th>Party name</th></tr></thead><tbody><tr><td>`my_secret_1`</td><td>`SecretInteger`</td><td>`Nilla 🐶`</td></tr><tr><td>`my_secret_2`</td><td>`SecretInteger`</td><td>`Nilla 🐶`</td></tr></tbody></table>

The program [`tiny_addition.py`](https://github.com/nillion-oss/nillion-python-starter/blob/main/programs/tiny_secret_addition_complete.py) returns an [Output](concepts.md#outputs) to a [Party](concepts.md#party). Only that party sees the output because it it of type `SecretInteger`.
The program [`tiny_addition.py`](https://github.com/nillion-oss/nillion-python-starter/blob/main/programs/tiny_secret_addition_complete.py) returns an [Output](concepts.md#outputs) to a [Party](concepts.md#party). Only that party sees the output because it of type `SecretInteger`.

<table>
<thead>
Expand Down
4 changes: 2 additions & 2 deletions docs/nada-numpy-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Finally, we need to produce the output. Since `NadaArray` is not a base Nada typ
return res.output(parties[2], "my_output")
```

In this case, we'll be invoking `res.output(parties[2], "my_output")` establishing that the output party will be `Party2`and the name of the output variable will be `"my_output"`.
In this case, we'll be invoking `res.output(parties[2], "my_output")` establishing that the output party will be `Party2` and the name of the output variable will be `"my_output"`.

With everything in place, we can build and test our program:

Expand All @@ -130,7 +130,7 @@ nada build

## Using Nada Numpy with Nillion Network

After completing the program writing, we can upload it and interact with it in the network with the ease provided by Nada Numpy. For that, we use the Python Nillion Client. We can use the same complete code as for other examples. The only difference is how Nada Numpy allows to easily include arrays in our uploads to the Nillion Networ with the Nada Numpy client. We add the link to the [complete code](https://github.com/NillionNetwork/nada-algebra/blob/main/examples/broadcasting/main.py).
After completing the program writing, we can upload it and interact with it in the network with the ease provided by Nada Numpy. For that, we use the Python Nillion Client. We can use the same complete code as for other examples. The only difference is how Nada Numpy allows to easily include arrays in our uploads to the Nillion Network with the Nada Numpy client. We add the link to the [complete code](https://github.com/NillionNetwork/nada-algebra/blob/main/examples/broadcasting/main.py).

First, import the necessary modules:

Expand Down
4 changes: 2 additions & 2 deletions docs/nada.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ Run a program with the --metrics flag to retrieve detailed execution metrics of
- json: Outputs metrics in JSON format and saves it to a metrics.json file.
- yaml: Outputs metrics in YAML format and saves it to a metrics.yaml file.

For detailed information on the metrics reported, pleas, visit the [Nada Metrics](/nada-metrics) section.
For detailed information on the metrics reported, please, visit the [Nada Metrics](/nada-metrics) section.

#### Example metrics usage

Expand Down Expand Up @@ -612,4 +612,4 @@ https://github.com/NillionNetwork/nada-by-example/blob/main/src/list_scan_linear
https://github.com/NillionNetwork/nada-by-example/blob/main/tests/list_scan_linear_test.yaml
```
</TabItem>
</Tabs>
</Tabs>
4 changes: 2 additions & 2 deletions docs/python-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The [Nillion Python Starter repo](https://github.com/NillionNetwork/nillion-pyth
source .venv/bin/activate
```

5. Intall the requirements
5. Install the requirements
```bash
pip install --upgrade -r requirements.txt
```
Expand Down Expand Up @@ -430,7 +430,7 @@ Congratulations, you've successfully written your first single party Nada progra
- Examples:
- [single party examples](https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/core_concept_single_party_compute)
- [multi-party examples](https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/core_concept_multi_party_compute)
- [storing and retrieving intergers and blobs](https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/core_concept_store_and_retrieve_secrets)
- [storing and retrieving integers and blobs](https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/core_concept_store_and_retrieve_secrets)
- [using permissions](https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/core_concept_permissions)
- Tutorials:
- [Voting schemes](https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/voting_tutorial)
Expand Down
4 changes: 2 additions & 2 deletions docs/start-building.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The [Nada Quickstart](/quickstart-nada) will teach you how to create a Nada proj

## Build a Blind App

This [Blind App Quickstart](/quickstart) is ideal for developers interested in **building frontends or fullstack web apps** on Nillion. This quickstart will guide you through writing a Nada program, storing the program on the Nillion Netowrk, and creating a blind web app lets you store secrets and run your Nada program in the browser.
This [Blind App Quickstart](/quickstart) is ideal for developers interested in **building frontends or fullstack web apps** on Nillion. This quickstart will guide you through writing a Nada program, storing the program on the Nillion Network, and creating a blind web app lets you store secrets and run your Nada program in the browser.

## Connect a backend to Nillion

Expand All @@ -17,4 +17,4 @@ If you want to **connect a backend** to Nillion, check out the Nillion [Python Q

## Write a privacy-preserving Blind AI Nada program

To write privacy-preserving AI programs, check out our [Nada AI](/nada-by-example/nada-ai) examples, tutorials, and Google Colab links.
To write privacy-preserving AI programs, check out our [Nada AI](/nada-by-example/nada-ai) examples, tutorials, and Google Colab links.