docs(tutorial): polish image2image #3843

alexcg1 · 2021-11-01T11:15:21Z

Just polishing up the wording a little bit

alexcg1 · 2021-11-01T11:21:14Z

Did we want to explain the indexer here? Instead we're just directing people to our concept docs

covered. In Jina we have three fundamental concepts that you need to know to follow this tutorial. If you
haven't read it yet, head on over to [Jina's basic concepts](https://docs.jina.ai/fundamentals/concepts/) page.

I'd suggest that instead of this, we can just link the first occurrence of Document, Executor and Flow to their respective docs page

alexcg1 · 2021-11-01T11:21:35Z

Did we want to explain the indexer here? Instead we're just directing people to our concept docs
covered. In Jina we have three fundamental concepts that you need to know to follow this tutorial. If you
haven't read it yet, head on over to [Jina's basic concepts](https://docs.jina.ai/fundamentals/concepts/) page. 
I'd suggest that instead of this, we can just link the first occurrence of Document, Executor and Flow to their respective docs page

And/or mention that readers should check the basic concepts before they start

makram93 · 2021-11-01T11:26:10Z

I think we can remove the explanation. They would have gone through the basics before this tutorial

codecov · 2021-11-01T11:29:39Z

Codecov Report

Merging #3843 (800d7d0) into master (a66b4aa) will decrease coverage by 5.55%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3843      +/-   ##
==========================================
- Coverage   86.14%   80.59%   -5.56%     
==========================================
  Files         156      156              
  Lines       12213    12223      +10     
==========================================
- Hits        10521     9851     -670     
- Misses       1692     2372     +680

Flag	Coverage Δ
daemon	`?`
jina	`79.13% <ø> (-6.47%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
jina/helloworld/chatbot/my_executors.py	`0.00% <0.00%> (-95.56%)`	⬇️
jina/helloworld/fashion/my_executors.py	`0.00% <0.00%> (-93.16%)`	⬇️
jina/helloworld/fashion/helper.py	`0.00% <0.00%> (-90.82%)`	⬇️
jina/helloworld/chatbot/app.py	`0.00% <0.00%> (-83.68%)`	⬇️
jina/helloworld/fashion/app.py	`0.00% <0.00%> (-81.82%)`	⬇️
jina/hubble/hubio.py	`9.84% <0.00%> (-78.42%)`	⬇️
jina/hubble/hubapi.py	`20.00% <0.00%> (-75.24%)`	⬇️
jina/hubble/helper.py	`23.24% <0.00%> (-67.57%)`	⬇️
jina/parsers/deprecated.py	`33.33% <0.00%> (-50.01%)`	⬇️
jina/clients/helper.py	`50.00% <0.00%> (-50.00%)`	⬇️
... and 49 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a66b4aa...800d7d0. Read the comment docs.

alexcg1 · 2021-11-01T11:32:22Z

I think we can remove the explanation. They would have gone through the basics before this tutorial

We live in hope

github-actions · 2021-11-01T11:41:45Z

📝 Docs are deployed on https://docs-tutorial-similar-image-polish--jina-docs.netlify.app 🎉

github-actions · 2021-11-01T11:41:45Z

📝 Docs are deployed on https://docs-tutorial-similar-image-polish--jina-docs.netlify.app 🎉

github-actions · 2021-11-01T11:46:12Z

Latency summary

Current PR yields:

😶 index QPS at 1094, delta to last 2 avg.: -2%
😶 query QPS at 52, delta to last 2 avg.: +0%
😶 dam extend QPS at 35477, delta to last 2 avg.: -15%
😶 avg flow time within 1.3914 seconds, delta to last 2 avg.: +0%
😶 import jina within 0.4654 seconds, delta to last 2 avg.: -1%

Breakdown

Version	Index QPS	Query QPS	DAM Extend QPS	Avg Flow Time (s)	Import Time (s)
current	1094	52	35477	1.3914	0.4654
`2.2.2`	1083	50	38650	1.1651	0.5306
`2.2.1`	1157	53	45046	1.5964	0.417

Backed by latency-tracking. Further commits will update this comment.

makram93 · 2021-11-01T11:46:10Z

docs/datatype/image/image2image.md

+We will use the **SimpleIndexer** Executor as
+our indexer (the one that stores and retrieves data). This Executor also returns the matching `Document` when we make


Suggested change

We will use the **SimpleIndexer** Executor as

our indexer (the one that stores and retrieves data). This Executor also returns the matching `Document` when we make

The **Indexer** executor support vector search along with indexing. For this tutorial we will create our own **Indexer** based on `SimpleIndexer` executor available on Jina Hub. This Executor returns the matching `Document` when we make

Automated message

Capitalization

Please capitalize first letters of the following (when used to reference project or component):

Flow

Executor

Document

Jina

Jina Hub

Python

Docker

Kubernetes

Note!

This only applies outside a code or CLI context. If you're describing Python, YAML, any programming language, or command line input/output, please use the capitalization you would use in that context.

Right

from jina.flow import Flow

Wrong

from Jina.Flow import Flow

Made with GitHub saved replies

Remove "should"

makram93 · 2021-11-01T11:50:36Z

docs/datatype/image/image2image.md

-getting the embeddings. Reader can replace this model with any other pre-trained models of their choice. When this
-executor is instantiated, the pre-trained weights are downloaded automatically. The `predict` function takes in
-the `DocumentArray` and extracts embeddings which is then stored in the `embedding` attribute of the
+To build an Encoder Executor we inherit the base `Executor` and use a decorator


Suggested change

To build an Encoder Executor we inherit the base `Executor` and use a decorator

To build an `Encoder` Executor we inherit the base `Executor` and use a decorator

I don't think we need to backtick Encoder or Executor here. We're talking about them as concepts, not code

makram93 · 2021-11-01T11:54:59Z

docs/datatype/image/image2image.md

+Finally, comes the storage/retrieval step. We do this with the **Indexer** Executor. You can use any of the
+available indexers on [Jina Hub](https://hub.jina.ai) or define your own. To create an **Indexer** you need to have two
+endpoints: `/index` and `/search`. For this tutorial we will define a `SimpleIndexer` which is [also available on jina
+Hub](https://hub.jina.ai/executor/zb38xlt4).


Suggested change

Finally, comes the storage/retrieval step. We do this with the **Indexer** Executor. You can use any of the

available indexers on [Jina Hub](https://hub.jina.ai) or define your own. To create an **Indexer** you need to have two

endpoints: `/index` and `/search`. For this tutorial we will define a `SimpleIndexer` which is [also available on jina

Hub](https://hub.jina.ai/executor/zb38xlt4).

Finally, comes the storage/retrieval step. You can use any of the

available indexers on [Jina Hub](https://hub.jina.ai) or define your own. To create an **Indexer** you need to have two

endpoints: `/index` and `/search`. We can create an Executor which supports vector search and indexing as follows:

docs(tutorial): polish image2image

8b4cea1

alexcg1 self-assigned this Nov 1, 2021

alexcg1 requested review from CatStark and makram93 November 1, 2021 11:15

docs(tutorial): typo

023bd24

github-actions bot added size/M area/docs This issue/PR affects the docs labels Nov 1, 2021

docs(tutorial): further polish image2image

0c4d1f4

docs(tutorial): remove basics link

800d7d0

makram93 reviewed Nov 1, 2021

View reviewed changes

hanxiao merged commit 5905c85 into master Nov 2, 2021

hanxiao deleted the docs-tutorial-similar-image-polish branch November 2, 2021 16:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(tutorial): polish image2image #3843

docs(tutorial): polish image2image #3843

alexcg1 commented Nov 1, 2021

alexcg1 commented Nov 1, 2021

alexcg1 commented Nov 1, 2021

makram93 commented Nov 1, 2021

codecov bot commented Nov 1, 2021 •

edited

alexcg1 commented Nov 1, 2021

github-actions bot commented Nov 1, 2021

github-actions bot commented Nov 1, 2021

github-actions bot commented Nov 1, 2021 •

edited

makram93 Nov 1, 2021 •

edited

alexcg1 Nov 1, 2021

alexcg1 Nov 1, 2021

makram93 Nov 1, 2021

alexcg1 Nov 1, 2021

makram93 Nov 1, 2021

		We will use the SimpleIndexer Executor as
		our indexer (the one that stores and retrieves data). This Executor also returns the matching `Document` when we make

	We will use the SimpleIndexer Executor as
	our indexer (the one that stores and retrieves data). This Executor also returns the matching `Document` when we make
	The Indexer executor support vector search along with indexing. For this tutorial we will create our own Indexer based on `SimpleIndexer` executor available on Jina Hub. This Executor returns the matching `Document` when we make

	To build an Encoder Executor we inherit the base `Executor` and use a decorator
	To build an `Encoder` Executor we inherit the base `Executor` and use a decorator

docs(tutorial): polish image2image #3843

docs(tutorial): polish image2image #3843

Conversation

alexcg1 commented Nov 1, 2021

alexcg1 commented Nov 1, 2021

alexcg1 commented Nov 1, 2021

makram93 commented Nov 1, 2021

codecov bot commented Nov 1, 2021 • edited

Codecov Report

alexcg1 commented Nov 1, 2021

github-actions bot commented Nov 1, 2021

github-actions bot commented Nov 1, 2021

github-actions bot commented Nov 1, 2021 • edited

Latency summary

Breakdown

makram93 Nov 1, 2021 • edited

Choose a reason for hiding this comment

alexcg1 Nov 1, 2021

Choose a reason for hiding this comment

Capitalization

Note!

Right

Wrong

alexcg1 Nov 1, 2021

Choose a reason for hiding this comment

makram93 Nov 1, 2021

Choose a reason for hiding this comment

alexcg1 Nov 1, 2021

Choose a reason for hiding this comment

makram93 Nov 1, 2021

Choose a reason for hiding this comment

codecov bot commented Nov 1, 2021 •

edited

github-actions bot commented Nov 1, 2021 •

edited

makram93 Nov 1, 2021 •

edited