FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: make document indices self-contained by jupyterjazz · Pull Request #1678 · docarray/docarray · GitHub

/ docarray Public

docs: make document indices self-contained - #1678

Merged
JoanFM merged 35 commits into
mainfrom
docs-self-contained-indices
Aug 1, 2023
ConversationCommits (35)ChecksFiles changed
Merged

docs: make document indices self-contained#1678
JoanFM merged 35 commits into
mainfrom
docs-self-contained-indices

Conversation

jupyterjazz commented Jun 28, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

As stated in #1603, our documentation for doc indices is not consistent and lacks some of the functionalities.

Definition of Done:

  • come up with a rough template, i.e. what should each page include, and rewrite doc indices accordingly
  • modify the doc index introduction page
  • add docs for redis
  • add docs for milvus
  • add docs for qdrant
  • validate code examples
  • refine text

High-level Template:

  • Intro
  • Basic Usage
  • Initialize
  • Index
  • Vector Search
  • Filter
  • Text Search
  • Hybrid Search
  • Access Documents
  • Delete Documents
  • Update Documents
  • Configuration
  • Nested Data

chore: first pr
caa00fd 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>
jupyterjazz linked an issue Jun 28, 2023 that may be closed by this pull request
Docs: make each doc index documentation self-contained #1603
Closed
JoanFM marked this pull request as draft July 6, 2023 07:13
docs: modify hnsw
b45e3a6 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>
jupyterjazz and others added 3 commits July 6, 2023 17:07
Merge branch 'main' into docs-self-contained-indices
cad4e60
docs: rough versions of inmemory and hnsw
11bda62 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>
chore: update branch
96319ca 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>
github-actions Bot added size/xl and removed size/m labels Jul 6, 2023

github-actions Bot commented Jul 6, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

docs: weaviate v1
f5825f8 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>

github-actions Bot commented Jul 6, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

docs: elastic v1
8aaedbe 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>

github-actions Bot commented Jul 17, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

codecov Bot commented Jul 17, 2023 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Patch coverage has no change and project coverage change: -54.40% ⚠️

Comparison is base (31c2bb9) 84.46% compared to head (b402802) 30.06%.

Additional details and impacted files 
@@             Coverage Diff             @@
##             main    #1678       +/-   ##
===========================================
- Coverage   84.46%   30.06%   -54.40%     
===========================================
  Files         134      133        -1     
  Lines        8838     8731      -107     
===========================================
- Hits         7465     2625     -4840     
- Misses       1373     6106     +4733
Flag Coverage Δ
docarray 30.06% <ø> (-54.40%) ⬇️

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

see 110 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs: introduction page
4a3e25c 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>

github-actions Bot commented Jul 17, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

docs: redis v1
db77beb 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>

github-actions Bot commented Jul 17, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

docs: qdrant v1
82afb99 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>

github-actions Bot commented Jul 17, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

docs: validate intro inmemory and hnsw examples
befc786 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>

github-actions Bot commented Jul 17, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

docs: validate elastic and qdrant examples
9bdb0dc 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>

github-actions Bot commented Jul 17, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

docs: validate code examples for redis and weaviate
64f83bf 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>
alexcg1 suggested changes Jul 31, 2023
View reviewed changes

alexcg1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Ensure:

  • Consistent use of document/Document
  • H1 headings are title case, H2 and lower are sentence case

Comment thread docs/user_guide/storing/nested_data.md Outdated
Comment thread docs/user_guide/storing/index_elastic.md Outdated
Comment thread docs/user_guide/storing/index_elastic.md Outdated
Comment thread docs/user_guide/storing/index_elastic.md Outdated
Comment thread docs/user_guide/storing/index_elastic.md Outdated
Comment thread docs/user_guide/storing/index_hnswlib.md Outdated
Comment thread docs/user_guide/storing/index_in_memory.md Outdated
Comment thread docs/user_guide/storing/index_milvus.md Outdated
Comment thread docs/user_guide/storing/index_qdrant.md Outdated
Comment thread docs/user_guide/storing/index_weaviate.md
### Instantiation instructions

### 1.2.1. WCS (managed instance)
**WCS (managed instance)**

alexcg1 Jul 31, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Should these be h4 headings?

jupyterjazz Jul 31, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

yes but the table of contets got too verbose

JohannesMessner requested changes Jul 31, 2023
View reviewed changes

JohannesMessner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think there is a small issue with the way things are currently set up.
The pages on HNSWLib and InMemory seem to be fully self-contained, giving general information like the following:

But this (and some other backend agnostic information) seems to be missing from the pages describing other backends (weavaite, qdrant, etc).

If we want thins to be truly self-contained, then we should just copy that sort of information to all the backends imo.

But I like the direction this is going into!!

Comment thread docs/user_guide/storing/docindex.md
through [build_query()][docarray.index.abstract.BaseDocIndex.build_query]:

### Initialize the Document Index and add data
```python

JohannesMessner Jul 31, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

can we add 1-2 sentences of explanation to these code snippets? i think they are very self-explanatory, but personally as a user i don't like code snippets without words around them :)

Comment thread docs/user_guide/storing/docindex.md
.build() # build the query
)
retrieved_docs, scores = doc_index.execute_query(query)
```

JohannesMessner Jul 31, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think we should here again add a big fat link to all the backend documentation pages and tell people that they can get more detailed information there

docs: apply suggestions vol2
41c7307 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>

github-actions Bot commented Jul 31, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

fix: nested data imports
a32a1e5 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>

github-actions Bot commented Jul 31, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

github-actions Bot commented Aug 1, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

docs: apply johannes suggestions
ef0b7ef 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>
chore: merge conflicts
6818688 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>

github-actions Bot commented Aug 1, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

alexcg1 suggested changes Aug 1, 2023
View reviewed changes

alexcg1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Key points:

  • Change all "top 10 most similar" to "ten most similar" throughout
  • Wrap all methods in backticks. Some still lack them
  • H2 headings and lower should be sentence case. Some are still title case

There are a few other items throughout the review too

Comment thread docs/user_guide/storing/docindex.md Outdated
Comment thread docs/user_guide/storing/docindex.md Outdated
Comment thread docs/user_guide/storing/docindex.md Outdated
Comment thread docs/user_guide/storing/docindex.md Outdated
Comment thread docs/user_guide/storing/docindex.md Outdated
Comment thread docs/user_guide/storing/index_elastic.md Outdated
Comment thread docs/user_guide/storing/index_hnswlib.md Outdated
Comment thread docs/user_guide/storing/index_milvus.md Outdated
Comment thread docs/user_guide/storing/index_qdrant.md Outdated
Comment thread docs/user_guide/storing/index_weaviate.md Outdated

JohannesMessner commented Aug 1, 2023

Copy link
Copy Markdown
Member

Key points:

* Change all "top 10 most similar" to "ten most similar" throughout

* Wrap all methods in backticks. Some still lack them

* H2 headings and lower should be sentence case. Some are still title case

There are a few other items throughout the review too

Even better than backticks would be to link the the corresponding docstring / API docs :)

docs: apply suggestions
9268161 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>
jupyterjazz requested a review from alexcg1 August 1, 2023 11:18

github-actions Bot commented Aug 1, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

jupyterjazz commented Aug 1, 2023

Copy link
Copy Markdown
Contributor Author

Even better than backticks would be to link the the corresponding docstring / API docs :)

already linked, they just lacked the backticks

alexcg1 commented Aug 1, 2023

Copy link
Copy Markdown
Contributor

Even better than backticks would be to link the the corresponding docstring / API docs :)
Many method names do link to that stuff, just not backticked

alexcg1 suggested changes Aug 1, 2023
View reviewed changes

alexcg1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Final nitpicks

Comment thread docs/user_guide/storing/docindex.md Outdated
Comment thread docs/user_guide/storing/index_hnswlib.md Outdated
Comment thread docs/user_guide/storing/index_in_memory.md Outdated
docs: app sgg
b402802 
Signed-off-by: jupyterjazz <saba.sturua@jina.ai>

github-actions Bot commented Aug 1, 2023

Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

github-actions Bot commented Aug 1, 2023

Copy link
Copy Markdown

📝 Docs are deployed on https://ft-docs-self-contained-indices--jina-docs.netlify.app 🎉

JohannesMessner approved these changes Aug 1, 2023
View reviewed changes

JohannesMessner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

big win for people that are interested in a specific backend!

jupyterjazz requested review from JoanFM and alexcg1 August 1, 2023 11:59
JoanFM merged commit 7c10295 into main Aug 1, 2023
JoanFM deleted the docs-self-contained-indices branch August 1, 2023 12:07
jupyterjazz mentioned this pull request Aug 1, 2023
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

JohannesMessner JohannesMessner approved these changes
samsja Awaiting requested review from samsja
scott-martens Awaiting requested review from scott-martens
alexcg1 Awaiting requested review from alexcg1
JoanFM Awaiting requested review from JoanFM

Assignees

No one assigned

Labels

area/docs size/xl

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docs: make each doc index documentation self-contained

4 participants

Back | FazBrowse Home | New Git URL