refactor(readme): simplification and content update #2244

alexcg1 · 2021-03-26T11:04:39Z

Total refactor to simplify and attract more users. Have implemented most feedback - still need to follow up on some other points

github-actions · 2021-03-26T11:04:58Z

This PR closes: #3

codecov · 2021-03-26T11:09:40Z

Codecov Report

Merging #2244 (e9adc8c) into master (4fa7af2) will decrease coverage by 4.31%.
The diff coverage is n/a.

❗ Current head e9adc8c differs from pull request most recent head c976c7a. Consider uploading reports for the commit c976c7a to get more accurate results

@@            Coverage Diff             @@
##           master    #2244      +/-   ##
==========================================
- Coverage   90.62%   86.31%   -4.32%     
==========================================
  Files         209      209              
  Lines       11311    11284      -27     
==========================================
- Hits        10251     9740     -511     
- Misses       1060     1544     +484

Flag	Coverage Δ
daemon	`51.17% <ø> (-0.01%)`	⬇️
jina	`86.55% <ø> (-4.54%)`	⬇️

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

Impacted Files	Coverage Δ
jina/schemas/pod.py	`0.00% <0.00%> (-100.00%)`	⬇️
jina/schemas/flow.py	`0.00% <0.00%> (-100.00%)`	⬇️
jina/schemas/meta.py	`0.00% <0.00%> (-100.00%)`	⬇️
jina/schemas/driver.py	`0.00% <0.00%> (-100.00%)`	⬇️
jina/schemas/request.py	`0.00% <0.00%> (-100.00%)`	⬇️
jina/schemas/executor.py	`0.00% <0.00%> (-100.00%)`	⬇️
jina/helloworld/fashion/__init__.py	`0.00% <0.00%> (-100.00%)`	⬇️
jina/schemas/__init__.py	`7.14% <0.00%> (-92.86%)`	⬇️
jina/helloworld/multimodal/__init__.py	`0.00% <0.00%> (-90.91%)`	⬇️
jina/parsers/export_api.py	`0.00% <0.00%> (-87.50%)`	⬇️
... and 34 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 4fa7af2...c976c7a. Read the comment docs.

FionnD

LGTM! Some minor comments

FionnD · 2021-03-26T11:05:51Z

README.md

@@ -2,886 +2,114 @@
 <img src="https://github.com/jina-ai/jina/blob/master/.github/logo-only.gif?raw=true" alt="Jina banner" width="200px">
 </p>
 <p align="center">
-An easier way to build neural search on the cloud
+<h2 align="center">Deep Learning Neural Search Framework for Any Kind of Data</h2>


Should this sentence case? Personally I think it would read better, but just imo

I just checked a few other repo's to see what they do, and some do sentence, some do title. Let's leave it for now

FionnD · 2021-03-26T11:06:21Z

README.md

 </p>
 <p align=center>
 <a href="https://pypi.org/project/jina/"><img src="https://github.com/jina-ai/jina/blob/master/.github/badges/python-badge.svg?raw=true" alt="Python 3.7 3.8 3.9" title="Jina supports Python 3.7 and above"></a>
 <a href="https://pypi.org/project/jina/"><img src="https://img.shields.io/pypi/v/jina?color=%23099cec&amp;label=PyPI&amp;logo=pypi&amp;logoColor=white" alt="PyPI"></a>
 <a href="https://hub.docker.com/r/jinaai/jina/tags"><img src="https://img.shields.io/docker/v/jinaai/jina?color=%23099cec&amp;label=Docker&amp;logo=docker&amp;logoColor=white&amp;sort=semver" alt="Docker Image Version (latest semver)"></a>
-<a href="https://github.com/jina-ai/jina/actions?query=workflow%3ACI"><img src="https://github.com/jina-ai/jina/workflows/CI/badge.svg" alt="CI"></a>
-<a href="https://github.com/jina-ai/jina/actions?query=workflow%3ACD"><img src="https://github.com/jina-ai/jina/workflows/CD/badge.svg?branch=master" alt="CD"></a>
-<a href="https://codecov.io/gh/jina-ai/jina"><img src="https://codecov.io/gh/jina-ai/jina/branch/master/graph/badge.svg" alt="codecov"></a>


I would keep the code coverage button, I don't think the percentage is that bad?

Sure, I'm open to that

FionnD · 2021-03-26T11:07:34Z

README.md

-### YAML Completion in IDE
-
-Developing Jina app often means writing YAML configs. We provide a [JSON Schema](https://json-schema.org/) for your IDE to enable code completion, syntax validation, members listing and displaying help text. Here is a [video tutorial](https://youtu.be/qOD-6mihUzQ) to walk you through the setup.
+Jina is a neural search framework for building <strong>cross-/multi-media search systems</strong> on the cloud, powered by best-in-class AI models.


AI or ML? I think ML is more common in the industry.

I'm also not sure if it should be a neural or an neural

ML works for me. Changed

FionnD · 2021-03-26T11:10:26Z

README.md


-#### Asynchronous Flow
-<a href="https://mybinder.org/v2/gh/jina-ai/jupyter-notebooks/main?filepath=basic-inter-intra-parallelism.ipynb"><img align="right" src="https://github.com/jina-ai/jina/blob/master/.github/badges/run-badge.svg?raw=true"/></a>
+With Jina you can search through any kind of data, whether that's [text](https://github.com/jina-ai/examples/tree/master/wikipedia-sentences), [images](https://github.com/jina-ai/examples/tree/master/pokedex-with-bit), [audio](https://github.com/jina-ai/examples/tree/master/audio-search) or [video](https://github.com/jina-ai/examples/tree/master/tumblr-gif-search). We leverage AI models that have pre-trained and released by Facebook, Google, Spotify, and more. With the modular framework you can find the right tool for the right job -- whether that's crafting, encoding, classifying, indexing, or querying data. Alternatively, assemble them all into one [Flow](https://101.jina.ai/#Flow) for a unified end-to-end experience. 


I would remove simply, I think it make the sentence read more confidently

I would also add "this approach", it's sounds better.

Where would you add "this approach"?

FionnD · 2021-03-26T11:11:13Z

.github/pages/hello-world.md

+jina hello multimodal
+```
+
+This downloads [people image dataset](https://www.kaggle.com/ahmadahmadzada/images2000) and tells Jina to index 2,000 image-caption pairs with MobileNet and DistilBERT. The index process takes about 3 minute on CPU. Then it opens a web page where you can query multimodal documents. We have prepared [a YouTube tutorial](https://youtu.be/B_nH8GCmBfc) to walk you through this demo.


Should we direct the user to where to go next?

Let's worry about that later. We can put it in the next revision

FionnD · 2021-03-26T11:11:53Z

.github/pages/snippets.md

+pip install jina[hub] && jina hub new --type app
+```
+
+This creates a Python entrypoint, YAML configs and a Dockerfile. You can start from there.


Again, should we suggest where to go next?

FionnD · 2021-03-26T11:12:44Z

.github/pages/snippets.md

@@ -0,0 +1,694 @@
+# Jina Code Snippets
+
+These code snippets cover all aspects of Jina's functionality. To run a snippet in a Jupyter Notebook, just click the "run" button next to the snippet.


I wouldn't claim they cover all. They are a short and easy introduction to Jina functionality and design framework.

github-actions · 2021-03-26T11:20:40Z

Latency summary

Current PR yields:

😶 index QPS at 1061, delta to last 3 avg.: +0%
😶 query QPS at 17, delta to last 3 avg.: -3%

Breakdown

Version	Index QPS	Query QPS
current	1061	17
`1.1.0`	1062	17
`1.0.16`	1054	17

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

# Conflicts: # README.md

github-actions · 2021-03-30T13:06:59Z

Thanks for your contribution ❤️
💔 Unfortunately, this PR has one ore more bad commit messages, it can not be merged. To fix this problem, please refer to:

Note, other CI tests will not start until the commit messages get fixed.

This message will be deleted automatically when the commit messages get fixed.

alexcg1 added 16 commits March 23, 2021 16:07

refactor(readme): total refactor WIP

1d39deb

refactor(readme): added notes

1bc18b3

refactor(readme): wording

4725bbd

refactor(readme-notes): add items to table

f7c01b1

refactor(readme-notes): add simple sample code

22f9bc3

refactor(readme-notes): action items, best practices

7d01dc5

refactor(readme): move notes to private repo

1043032

refactor(readme): wording

9eebfa5

refactor(readme): add snippets, hello world pages, han feedback

939b0da

refactor(snippets, helloworld): front matter

63f79d9

refactor(readme): hello world links

152291a

refactor(readme): table emoji size

89cbcaa

refactor(readme): support, rewrite eah

f440479

refactor(readme): upgrade examples section heading

f48be87

refactor(readme): add first issues

4e4d154

refactor(readme): add eah to support

027918c

alexcg1 requested a review from FionnD March 26, 2021 11:04

alexcg1 self-assigned this Mar 26, 2021

alexcg1 requested review from hanxiao and a team as code owners March 26, 2021 11:04

jina-bot added size/XL area/housekeeping This issue/PR is housekeeping labels Mar 26, 2021

refactor(readme): add product board to support

5d21c32

refactor(readme): formatting

b0573f2

FionnD suggested changes Mar 26, 2021

View reviewed changes

alexcg1 added 2 commits March 26, 2021 13:17

refactor(readme): fionn feedback implemented

cf983af

refactor(readme): wording

e9adc8c

alexcg1 marked this pull request as draft March 28, 2021 18:37

hanxiao and others added 6 commits March 30, 2021 20:35

docs: fix readme

dfe075f

test: fix broken tests

89eb9ae

docs: fix readme

91cf48b

docs: fix readme

738d11a

Update hello-world.md

03f659b

Merge branch 'master' into refactor-readme-2021-03

c976c7a

# Conflicts: # README.md

hanxiao marked this pull request as ready for review March 30, 2021 13:06

hanxiao merged commit c861055 into master Mar 30, 2021

hanxiao deleted the refactor-readme-2021-03 branch March 30, 2021 13:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(readme): simplification and content update #2244

refactor(readme): simplification and content update #2244

alexcg1 commented Mar 26, 2021

github-actions bot commented Mar 26, 2021

codecov bot commented Mar 26, 2021 •

edited

FionnD left a comment

FionnD Mar 26, 2021

alexcg1 Mar 26, 2021

FionnD Mar 26, 2021

alexcg1 Mar 26, 2021

FionnD Mar 26, 2021

alexcg1 Mar 26, 2021

FionnD Mar 26, 2021

alexcg1 Mar 26, 2021

FionnD Mar 26, 2021

alexcg1 Mar 26, 2021

FionnD Mar 26, 2021

FionnD Mar 26, 2021

alexcg1 Mar 26, 2021

github-actions bot commented Mar 26, 2021 •

edited

github-actions bot commented Mar 30, 2021

		@@ -0,0 +1,694 @@
		# Jina Code Snippets

		These code snippets cover all aspects of Jina's functionality. To run a snippet in a Jupyter Notebook, just click the "run" button next to the snippet.

refactor(readme): simplification and content update #2244

refactor(readme): simplification and content update #2244

Conversation

alexcg1 commented Mar 26, 2021

github-actions bot commented Mar 26, 2021

codecov bot commented Mar 26, 2021 • edited

Codecov Report

FionnD left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Mar 26, 2021 • edited

Latency summary

Breakdown

github-actions bot commented Mar 30, 2021

codecov bot commented Mar 26, 2021 •

edited

github-actions bot commented Mar 26, 2021 •

edited