Skip to content

docs: add docs about list-like feature#762

Merged
JoanFM merged 6 commits intomainfrom
docs-add-docs-disabling-list-like
Nov 15, 2022
Merged

docs: add docs about list-like feature#762
JoanFM merged 6 commits intomainfrom
docs-add-docs-disabling-list-like

Conversation

@dongxiang123
Copy link
Copy Markdown
Contributor

Signed-off-by: dong xiang [email protected]

Goals:
Since this PR is merge and we need to add document about constructing a new backend in the document

  • ...
  • ...
  • check and update documentation, if required. See guide

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Nov 14, 2022

Codecov Report

Base: 86.57% // Head: 86.61% // Increases project coverage by +0.04% 🎉

Coverage data is based on head (d60cd8c) compared to base (d5b1db9).
Patch has no changes to coverable lines.

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

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #762      +/-   ##
==========================================
+ Coverage   86.57%   86.61%   +0.04%     
==========================================
  Files         133      133              
  Lines        6703     6703              
==========================================
+ Hits         5803     5806       +3     
+ Misses        900      897       -3     
Flag Coverage Δ
docarray 86.61% <ø> (+0.04%) ⬆️

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

Impacted Files Coverage Δ
docarray/array/mixins/plot.py 67.96% <0.00%> (+0.86%) ⬆️
docarray/math/distance/numpy.py 100.00% <0.00%> (+6.66%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@dongxiang123 dongxiang123 force-pushed the docs-add-docs-disabling-list-like branch from 60fb24e to 70adda7 Compare November 14, 2022 11:21
@JohannesMessner
Copy link
Copy Markdown
Member

I think we need to explain that this list_like parameter has to be part of the config, and then how it is passed to the __init__ of Offsed2ID.

@dongxiang123 dongxiang123 force-pushed the docs-add-docs-disabling-list-like branch from 70adda7 to d90a434 Compare November 14, 2022 15:43
@dongxiang123
Copy link
Copy Markdown
Contributor Author

I think we need to explain that this list_like parameter has to be part of the config, and then how it is passed to the __init__ of Offsed2ID.

added examples.

@dongxiang123 dongxiang123 force-pushed the docs-add-docs-disabling-list-like branch from d90a434 to 65d4850 Compare November 15, 2022 08:08
@dongxiang123 dongxiang123 force-pushed the docs-add-docs-disabling-list-like branch from d60cd8c to a95db51 Compare November 15, 2022 11:40
Co-authored-by: Joan Fontanals <[email protected]>
Signed-off-by: dong xiang <[email protected]>
@JoanFM JoanFM requested review from JoanFM and alexcg1 November 15, 2022 13:14
Comment on lines +87 to +90
want to also persist the ordering of Documents inside the storage. Considered the performance cost brought by list-like
structure implemented by Offset2id, you can disable this feature by passing a flag when constructing the backend.
After so, the Offset2id will become a shell and do nothing. Then in the `getsetdel.py` you can construct the _offset2ids
member variable by passing list_like flag as follows:
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.

Suggested change
want to also persist the ordering of Documents inside the storage. Considered the performance cost brought by list-like
structure implemented by Offset2id, you can disable this feature by passing a flag when constructing the backend.
After so, the Offset2id will become a shell and do nothing. Then in the `getsetdel.py` you can construct the _offset2ids
member variable by passing list_like flag as follows:
want to also persist the ordering of Documents inside the storage. Considering the performance cost brought by the list-like structure implemented by Offset2id, you can disable this feature by passing a flag when constructing the backend.
After this, the Offset2id will become a shell and do nothing. Then in the `getsetdel.py` you can construct the `_offset2ids`
member variable by passing the `list_like` flag as follows:

config3: Dict
...
```
By default, it is set to be `True`.
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.

Suggested change
By default, it is set to be `True`.
By default, it is set to `True`.

@github-actions
Copy link
Copy Markdown

📝 Docs are deployed on https://ft-docs-add-docs-disabling-list-like--jina-docs.netlify.app 🎉

Co-authored-by: Alex Cureton-Griffiths <[email protected]>
Signed-off-by: Johannes Messner <[email protected]>
@JoanFM JoanFM merged commit 97374ec into main Nov 15, 2022
@JoanFM JoanFM deleted the docs-add-docs-disabling-list-like branch November 15, 2022 14:07
@github-actions
Copy link
Copy Markdown

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants