From 4e6e87dd0ebc19da45df3c654c1745b908549527 Mon Sep 17 00:00:00 2001 From: Alex C-G Date: Wed, 12 Apr 2023 10:25:43 +0200 Subject: [PATCH 1/2] docs(menu): consistency, wording fixes Signed-off-by: Alex C-G --- docs/how_to/audio2text.md | 8 ++++---- docs/how_to/multimodal_training_and_serving.md | 2 +- docs/how_to/optimize_performance_with_id_generation.md | 2 +- docs/user_guide/sending/first_step.md | 2 +- docs/user_guide/storing/first_step.md | 2 +- mkdocs.yml | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/how_to/audio2text.md b/docs/how_to/audio2text.md index fcec869ce0f..d2f2507e08f 100644 --- a/docs/how_to/audio2text.md +++ b/docs/how_to/audio2text.md @@ -1,10 +1,10 @@ -# Creating an Audio to Text App with Jina and DocArray V2 +# Create an audio to text app with Jina and DocArray V2 -This is how you can build an Audio to Text app using Jina, Docarray and Whisper +This is how you can build an Audio to Text app using Jina, DocArray and Whisper. We will use: -* DocarrayV2: Helps us to load and preprocess multimodal data such as image, text and audio in our case +* DocArray V2: Helps us to load and preprocess multimodal data such as image, text and audio in our case * Jina: Helps us serve the model quickly and create a client First let's install requirements @@ -76,4 +76,4 @@ with Deployment( print(docs[0].text) ``` -And we get the transcribed result! \ No newline at end of file +And we get the transcribed result! diff --git a/docs/how_to/multimodal_training_and_serving.md b/docs/how_to/multimodal_training_and_serving.md index 9c30cbeffba..604545c7cd2 100644 --- a/docs/how_to/multimodal_training_and_serving.md +++ b/docs/how_to/multimodal_training_and_serving.md @@ -12,7 +12,7 @@ jupyter: name: python3 --- -# Multi-Modal Deep learning with DocList +# Multimodal deep learning with DocList DocList is a library for representing, sending, and storing multi-modal data that can be used for a variety of different use cases. diff --git a/docs/how_to/optimize_performance_with_id_generation.md b/docs/how_to/optimize_performance_with_id_generation.md index db46020faa2..5d0df78e776 100644 --- a/docs/how_to/optimize_performance_with_id_generation.md +++ b/docs/how_to/optimize_performance_with_id_generation.md @@ -1,4 +1,4 @@ -# How to optimize performance +# Optimize performance ### `BaseDoc`'s id diff --git a/docs/user_guide/sending/first_step.md b/docs/user_guide/sending/first_step.md index a18433535b9..1079b9dd75b 100644 --- a/docs/user_guide/sending/first_step.md +++ b/docs/user_guide/sending/first_step.md @@ -1 +1 @@ -# Sending +# Sending data diff --git a/docs/user_guide/storing/first_step.md b/docs/user_guide/storing/first_step.md index 5be8b39165b..e425d156e86 100644 --- a/docs/user_guide/storing/first_step.md +++ b/docs/user_guide/storing/first_step.md @@ -1 +1 @@ -# Storing +# Storing data diff --git a/mkdocs.yml b/mkdocs.yml index f4441995378..9f4fea24ff2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -72,9 +72,9 @@ plugins: nav: - Home: README.md - - Tutorial - User Guide: + - Tutorial/User Guide: - user_guide/intro.md - - Representing: + - Representing data: - user_guide/representing/first_step.md - user_guide/representing/array.md - user_guide/sending/first_step.md From 99a6f05a458607b47878edd36ad63a86874ea1ee Mon Sep 17 00:00:00 2001 From: Alex C-G Date: Wed, 12 Apr 2023 11:00:26 +0200 Subject: [PATCH 2/2] docs(intro): remove redundancy in title Signed-off-by: Alex C-G --- docs/user_guide/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user_guide/intro.md b/docs/user_guide/intro.md index 5c9fbb14d1f..94bb730fdb0 100644 --- a/docs/user_guide/intro.md +++ b/docs/user_guide/intro.md @@ -1,4 +1,4 @@ -# User Guide - Introduction +# Introduction This user guide shows you how to use `DocArray` with most of its features.