Skip to content

Commit

Permalink
GITBOOK-4: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
@Gonmeso @gitbook-bot
Gonmeso authored and gitbook-bot committed Feb 7, 2024
1 parent cdb4ca2 commit c8d53d5
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 17 deletions.
19 changes: 10 additions & 9 deletions docs/examples/basic.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,18 +80,19 @@ But don't worry, `giza` makes this process a breeze with a simple command! Let's

```console
> giza transpile awesome_model.onnx --output-path cairo_model

[giza][2023-09-13 12:56:43.725] No model id provided, checking if model exists ✅
[giza][2023-09-13 12:56:43.726] Model name is: awesome_model
[giza][2023-09-13 12:56:43.978] Model Created with id -> 25! ✅
[giza][2023-09-13 12:56:44.568] Sending model for transpilation ✅
[giza][2023-09-13 12:56:55.577] Transpilation recieved! ✅
[giza][2023-09-13 12:56:55.583] Transpilation saved at: cairo_model
[giza][2024-02-07 16:31:20.844] No model id provided, checking if model exists ✅
[giza][2024-02-07 16:31:20.845] Model name is: awesome_model
[giza][2024-02-07 16:31:21.599] Model Created with id -> 1! ✅
[giza][2024-02-07 16:31:22.436] Version Created with id -> 1! ✅
[giza][2024-02-07 16:31:22.437] Sending model for transpilation ✅
[giza][2024-02-07 16:32:13.511] Transpilation is fully compatible. Version compiled and Sierra is saved at Giza ✅
[giza][2024-02-07 16:32:13.516] Transpilation recieved! ✅
[giza][2024-02-07 16:32:14.349] Transpilation saved at: cairo_model
```

As you can see from the console output, if the model does not previously exist, `giza` will automatically create one for you. It assigns a unique id to the new model, in this case, the id is 25. This is indicated by the line `[giza][2023-09-13 12:56:43.978] Model Created with id -> 25! ✅`.
As you can see from the console output, if the model does not previously exist, `giza` will automatically create one for you. It assigns a unique id to the new model, in this case, the id is 25. This is indicated by the line `[giza][2024-02-07 16:31:21.599] Model Created with id -> 1! ✅`.

After the model is created, `giza` will create a new version for it and send it for transpilation. This is indicated by the line `[giza][2023-09-13 12:56:44.568] Sending model for transpilation ✅`. The transpiled model is then saved at the specified output path.
After the model is created, `giza` will create a new version for it `[giza][2024-02-07 16:31:22.436] Version Created with id -> 1! ✅` and send it for transpilation. This is indicated by the line `[giza][2024-02-07 16:31:22.437] Sending model for transpilation ✅`. The transpiled model is then saved at the specified output path.

This feature of `giza` makes it easy to manage and version your models. You don't have to worry about manually creating a new model or version, `giza` handles it for you.

Expand Down
37 changes: 31 additions & 6 deletions docs/frameworks/cairo/transpile.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,19 @@ The transpilation of an ONNX model to a Cairo model is powered by [✨Orion✨](

The transpilation process begins by reading the model from the specified path. The model is then sent for transpilation. By default, the output of this process is saved in the `cairo_model/` folder. However, you can specify a different output path using the `--output-path` option.

{% code overflow="wrap" %}
```console
> giza transpile awesome_model.onnx --output-path my_awesome_model
[giza][2023-09-13 12:56:43.725] No model id provided, checking if model exists ✅
[giza][2023-09-13 12:56:43.726] Model name is: awesome_model
[giza][2023-09-13 12:56:43.978] Model Created with id -> 1! ✅
[giza][2023-09-13 12:56:44.568] Sending model for transpilation ✅
[giza][2023-09-13 12:56:55.577] Transpilation recieved! ✅
[giza][2023-09-13 12:56:55.583] Transpilation saved at: cairo_model
[giza][2024-02-07 16:31:20.844] No model id provided, checking if model exists ✅
[giza][2024-02-07 16:31:20.845] Model name is: awesome_model
[giza][2024-02-07 16:31:21.599] Model Created with id -> 1! ✅
[giza][2024-02-07 16:31:22.436] Version Created with id -> 1! ✅
[giza][2024-02-07 16:31:22.437] Sending model for transpilation ✅
[giza][2024-02-07 16:32:13.511] Transpilation is fully compatible. Version compiled and Sierra is saved at Giza ✅
[giza][2024-02-07 16:32:13.516] Transpilation recieved! ✅
[giza][2024-02-07 16:32:14.349] Transpilation saved at: my_awesome_model
```
{% endcode %}

The result of the transpilation process is saved at the provided path, in this case, `my_awesome_model/`.

Expand All @@ -32,6 +36,25 @@ my_awesome_model
│ └── lib.cairo
```

When we transpile a model we have two possibilities: a fully compatible model and a partially compatible one. 

A model is fully compatible when all the operators that the model uses are supported by the Transpiler and Orion, if this happens the model is compiled after transpilation and we save the .sierra file on behalf of the user to use later for deployment ([deployment docs](../../resources/deployments.md)). This will be shown in the output of the transpile command:

{% code overflow="wrap" %}
```
[giza][2024-02-07 16:32:13.511] Transpilation is fully compatible. Version compiled and Sierra is saved at Giza ✅
```
{% endcode %}

If a model is partially supported, we will create a warning in the output stating that not all the operators are supported right now. If it is partially supported the Cairo code can still be modified for later compilation and deployment. 

{% code overflow="wrap" %}
```
[WARN][2024-02-07 16:42:31.209] 🔎 Transpilation is partially supported. Some operators are not yet supported in the Transpiler/Orion
[WARN][2024-02-07 16:42:31.211] Please check the compatibility list in Orion: https://cli.gizatech.xyz/frameworks/cairo/transpile#supported-operators
```
{% endcode %}

## Supported Operators

| Operator | Implemented |
Expand Down Expand Up @@ -94,6 +117,7 @@ This method is useful when you want to specify particular options or parameters
```console
> giza transpile --model-id 2 awesome_model.onnx --output-path new_awesome_model
[giza][2023-09-13 14:08:38.022] Model found with id -> 2! ✅
[giza][2024-02-07 14:08:38.432] Version Created with id -> 1! ✅
[giza][2023-09-13 14:08:38.712] Sending model for transpilation ✅
[giza][2023-09-13 14:08:49.879] Transpilation recieved! ✅
[giza][2023-09-13 14:08:49.885] Transpilation saved at: new_awesome_model
Expand All @@ -110,6 +134,7 @@ If you have a previously created model, you can transpile it by indicating the m
# Using the previous model (id: 2) we can transpile a new model, which will create version 2 of the model.
giza transpile --model-id 29 awesome_model.onnx --output-path new_awesome_model
[giza][2023-09-13 14:11:30.015] Model found with id -> 2! ✅
[giza][2024-02-07 14:11:30.225] Version Created with id -> 2! ✅
[giza][2023-09-13 14:11:30.541] Sending model for transpilation ✅
[giza][2023-09-13 14:11:41.601] Transpilation recieved! ✅
[giza][2023-09-13 14:11:41.609] Transpilation saved at: new_awesome_model
Expand Down
19 changes: 17 additions & 2 deletions docs/resources/deployments.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,25 @@ To create a new service, users can employ the `deploy` command. This command fac
```console
> giza deployments deploy --model-id 1 --version-id 1 model.sierra
▰▰▰▰▰▱▱ Creating deployment!
[giza][2024-01-17 17:18:17.055] Deployment is successful ✅
[giza][2024-01-17 17:18:17.056] Deployment created with endpoint URL: https://deployment-gizabrain-38-1-53427f44-dagsgas-ew.a.run.app 🎉
[giza][2024-02-07 12:31:02.498] Deployment is successful ✅
[giza][2024-02-07 12:31:02.501] Deployment created with id -> 1 ✅
[giza][2024-02-07 12:31:02.502] Deployment created with endpoint URL: https://deployment-gizabrain-38-1-53427f44-dagsgas-ew.a.run.app 🎉
```

If a model is fully compatible the sierra file is not needed and can be deployed without using it in the command:

```
> giza deployments deploy --model-id 1 --version-id 1
▰▰▰▰▰▱▱ Creating deployment!
[giza][2024-02-07 12:31:02.498] Deployment is successful ✅
[giza][2024-02-07 12:31:02.501] Deployment created with id -> 1 ✅
[giza][2024-02-07 12:31:02.502] Deployment created with endpoint URL: https://deployment-gizabrain-38-1-53427f44-dagsgas-ew.a.run.app 🎉
```

{% hint style="danger" %}
For a partially compatible model the sierra file must be provided, if not an error will be shown.
{% endhint %}

### Example request

Now our service is ready to accept predictions at the provided endpoint URL. To test this, we can use the `curl` command to send a POST request to the endpoint with a sample input.
Expand Down

0 comments on commit c8d53d5

Please sign in to comment.