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.

Sign up for GitHub

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

docs(example): update README.md #373

Merged
merged 1 commit into from
Oct 22, 2023
Merged

docs(example): update README.md #373

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions examples/README.md
View file
Open in desktop
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.