Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Adding documentation for the indexing components. #3

Merged
merged 23 commits into from
Jul 12, 2024
Merged

Adding documentation for the indexing components. #3

merged 23 commits into from
Jul 12, 2024

Conversation

codetalker7
Copy link
Member

@codetalker7 codetalker7 commented Jun 25, 2024 •
edited
Loading

This PR just adds some needed examples and documentation for the data, indexing types and their associated functions.

@codetalker7 codetalker7 mentioned this pull request Jul 11, 2024
Open
codetalker7 added 15 commits July 11, 2024 11:38
@codetalker7
Adding a bunch of docstrings related to the setup function. Also
1e24cf4 
adding some debug level log messages and asserts.
@codetalker7
Some minor fixes.
885bc5b
@codetalker7
Adding docstrings for some functions related to train, and adding
beb2b38 
some asserts and debug level logs.
@codetalker7
Adding shape of the centroids matrix in the docstring for `ResidualCo…
de029a2 
…dec`.
@codetalker7
Adding an assert in compress_into_codes.
123f022
@codetalker7
Adding docstrings for functions in index_saver.jl.
df1d475
@codetalker7
Adding docstrings for collection_encoder.jl.
b5c3f7c
@codetalker7
Adding more documentation for tensorize, and adding a simple assert.
da88bc8
@codetalker7
More documentation for BaseColBERT and Checkpoint.
f33eedf
@codetalker7
More documentation for mask_skiplist.
ddc2358
@codetalker7
Added a sanity check for tensorize.
1d3d9ee
@codetalker7
Adding an example in the docstring for ColBERTConfig.
5d8c70d
@codetalker7
Adding a reference to the config used in the docstring of BaseColBERT.
b2a07aa
@codetalker7
Adding docstrings for doc and docFromText.
3f72132
@codetalker7
Adding documentation for index and finalize.
78436bc
@codetalker7 codetalker7 merged commit 6e0f89f into main Jul 12, 2024
0 of 4 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@codetalker7