Skip to content

Commit

Permalink
docs(example): update README.md (#373)
Browse files Browse the repository at this point in the history
Because

- the documentation adopts the US spelling

This commit

- review the UK spelling to the US one, i.e., `visualisation` ->
`visualization`
  • Loading branch information
Pratikdate authored Oct 22, 2023
1 parent cff5911 commit 436f4c7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To better represent what is in each example folder, we follow a strict naming ru
Example:
`metabase-cv-object-deteciton-async-http-postgres`

- `{app}(optional)` indicates the app used in this example. For instance, `metabase` is an online interactive front-end that provides real-time data extraction from databases and visualisation.
- `{app}(optional)` indicates the app used in this example. For instance, `metabase` is an online interactive front-end that provides real-time data extraction from databases and visualization.
- `{AI task}` indicates the AI task demonstrated in the example. `cv-object-deteciton` means the AI task is an object detection in computer vision (CV).
- `{pipeline_mode}` indicates the pipeline modes, including `SYNC`, `ASYNC`, and `PULL`.
- `{source}` denotes the source connector of the pipeline. At the moment, VDP supports HTTP and gRPC.
Expand All @@ -28,4 +28,4 @@ Example:

## Example for Tutorials
- `instill` consists of examples where ML models are trained by Instill AI.
- `vdp-101` consists of examples used in the VDP-101 series. You can find basic but versatile examples to start building your pipelines.
- `vdp-101` consists of examples used in the VDP-101 series. You can find basic but versatile examples to start building your pipelines.

0 comments on commit 436f4c7

Please sign in to comment.