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 #24

Merged
merged 7 commits into from
Dec 6, 2023
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ Welcome to Giza CLI!

This CLI provides the utilities to interact with Giza using the terminal.

**Discalimer**: this is still in an experimental stage so the functionality is subject to change.
**Disclaimer**: this is still in an experimental stage so the functionality is subject to change.

- [Giza Command Line Interface](#giza-command-line-interface)
- [🚀 Installation](#-installation)
- [Recomended installation with pipx](#recomended-installation-with-pipx)
- [Recommended installation with pipx](#recommended-installation-with-pipx)
- [Install from PyPi](#install-from-pypi)
- [Installing from source](#installing-from-source)
- [📚 Documentation](#-documentation)
Expand All @@ -37,9 +37,9 @@ This CLI provides the utilities to interact with Giza using the terminal.

## 🚀 Installation

### Recomended installation with pipx
### Recommended installation with pipx

[pipx](https://pypa.github.io/pipx/) allows to install the dependency in an isolated environment. With ths we can make sure that it does not conflict with any of our installed dependencies.
[pipx](https://pypa.github.io/pipx/) allows to install the dependency in an isolated environment. With this we can make sure that it does not conflict with any of our installed dependencies.

```bash
pipx install giza-cli
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ This CLI provides the utilities to interact with Giza using the terminal.

## 🤔 What capabilities does the CLI offer?

The CLI will serve as the main entrypoint for Giza Platfrom for developers. It aims to provide a tool to ease the managing of resources that exists in Giza Plarform.
The CLI will serve as the main entrypoint for Giza Platform for developers. It aims to provide a tool to ease the managing of resources that exists in Giza Platform.

For now it provides the following capabilities:

* User related utilities, like `create` or `login`
* Model transpilation with `transpile`
* Create a proof from of a `casm.json` file with `prove`

In the future each new resource added to Giza will have its corresponding capabaility in the CLI.
In the future each new resource added to Giza will have its corresponding capability in the CLI.

## ✨ What's new?

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Enter your email 📧: gonzalo@gizatech.xyz
[giza][2023-06-23 12:29:41.417] User created ✅. Check for a verification email 📧
```

Then we need to verify the email. We just need to click on the buttom and we'll be redireted to the verification endpoint.
Then we need to verify the email. We just need to click on the button and we'll be redirected to the verification endpoint.

## Login

Expand Down
4 changes: 2 additions & 2 deletions docs/examples/create_proof.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ We need to install the following tools:

## Embed the model into a Starknet Contract

First, we need to compile the Cairo contract to a Starknet Contract, more information about starknet contracts [here](https://book.cairo-lang.org/ch99-00-starknet-smart-contracts.html). For now we don't need to dive deep into how these contracts works, as currently we need to make it a contract due a temporary limitation in the prover, once this is solved we should be able to generate the proof without the need of a contract.
First, we need to compile the Cairo contract to a Starknet Contract, more information about starknet contracts [here](https://book.cairo-lang.org/ch99-00-starknet-smart-contracts.html). For now we don't need to dive deep into how these contracts work, as currently we need to make it a contract due a temporary limitation in the prover, once this is solved we should be able to generate the proof without the need of a contract.

Add the `starknet` as a dependency in the `Scarb.toml` file:

Expand All @@ -38,7 +38,7 @@ mod OrionRunner {
// Kepp your imports as declared previously
// use ...

// Declare the contract storage, in this case is a dummy storage as we wo't use it
// Declare the contract storage, in this case is a dummy storage as we won't use it
#[storage]
struct Storage {
id: u8,
Expand Down
8 changes: 4 additions & 4 deletions docs/examples/full_transpilation.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ def train(epoch):
(batch_idx*64) + ((epoch-1)*len(train_loader.dataset)))
```

Time to start training the model! We have choosen 10 epochs, but you can increase/decrease the number as you wish.
Time to start training the model! We have chosen 10 epochs, but you can increase/decrease the number as you wish.


```python
Expand Down Expand Up @@ -305,7 +305,7 @@ We should be ready to start using Giza's capabilities, we can easily check by ru
}
```

Now we are ready to transpile our model to Cairo! We want to help you jumpstart your journey into ZKML by helping you to create this amazing models, we asbtract you from the tedious process of instrospecting the model and getting the ifnromation needed to use it in Cairo, thats why we build the transpilation process, to ease this and improve the iteration time from creating a model to using it in Cairo!
Now we are ready to transpile our model to Cairo! We want to help you jumpstart your journey into ZKML by helping you to create this amazing models, we abstract you from the tedious process of introspecting the model and getting the information needed to use it in Cairo, that's why we build the transpilation process, to ease this and improve the iteration time from creating a model to using it in Cairo!

Lets check how we can do it:

Expand All @@ -323,7 +323,7 @@ To explain a bit what is happening here, we are calling the `giza transpile` com

We can see that we make reference to a `model` this is because in Giza we organize the transpilations under models and versions:

* A `model` is a collection of versions of the same model, we we are iterating over the model and improving it we can create different versions of the same model and keep track of the changes.
* A `model` is a collection of versions of the same model, we are iterating over the model and improving it we can create different versions of the same model and keep track of the changes.
* A `version` is a reference to the transpiled model, each new transpilation will be referenced as a new version of the model.

We handle the creation for you, and if the model has the same name we will re-use the model and create a new version under it. If you want to know more about the model and version concept you can read the [docs](https://cli.gizatech.xyz/).
Expand All @@ -336,7 +336,7 @@ Also, if you ever have a question about the commands that you can run you can al

Back to the transpilation!

So we have recieve a file that we have saved in the `mnist_cairo` directory, lets check the contents of the directory:
So we have received a file that we have saved in the `mnist_cairo` directory, lets check the contents of the directory:

```console
❯ tree mnist_cairo
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Here's how you can do it:

## Retrieve Model Information

You can retrieve detailed information about a model stored on the server using its unique model id. This includes its name, descrtiption, and other id:
You can retrieve detailed information about a model stored on the server using its unique model id. This includes its name, description, and other id:

```console
> giza models get --model-id 1 # When we create model for you we output it in the logs so be aware
Expand Down
6 changes: 3 additions & 3 deletions docs/welcome/Installation.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Installation

* [🚀 Installation](Installation.md#-installation)
* [Recomended installation with pipx](Installation.md#recomended-installation-with-pipx)
* [Recommended installation with pipx](Installation.md#recommended-installation-with-pipx)
* [Install from PyPi](Installation.md#install-from-pypi)
* [Installing from source](Installation.md#installing-from-source)

## Recomended installation with pipx
## Recommended installation with pipx

[pipx](https://pypa.github.io/pipx/) allows to install the dependency in an isolated environment. With ths we can make sure that it does not conflict with any of our installed dependencies.
[pipx](https://pypa.github.io/pipx/) allows to install the dependency in an isolated environment. With this we can make sure that it does not conflict with any of our installed dependencies.

```bash
pipx install giza-cli
Expand Down