Docs maintenance #3999
Docs maintenance #3999
Conversation
|
The documentation is not available anymore as the PR was closed or merged. |
docs/source/faiss_es.mdx
Outdated
| @@ -32,7 +32,7 @@ FAISS retrieves documents based on the similarity of their vector representation | |||
| >>> ds_with_embeddings.add_faiss_index(column='embeddings') | |||
| ``` | |||
|
|
|||
| 4. Now you can query your dataset with the `embeddings` index. Load the DPR Question Encoder, and search for a question with [`Dataset.get_nearest_examples`]: | |||
| 4. Now you can query your dataset with the `embeddings` index. Load the DPR Question Encoder, and search for a question with [`~datasets.search.IndexableMixin.get_nearest_examples`]: | |||
There was a problem hiding this comment.
I think you can point to the Dataset method here no ? Or the doc builder is not able to resolve it ?
Same for the other search and tf methods
| 4. Now you can query your dataset with the `embeddings` index. Load the DPR Question Encoder, and search for a question with [`~datasets.search.IndexableMixin.get_nearest_examples`]: | |
| 4. Now you can query your dataset with the `embeddings` index. Load the DPR Question Encoder, and search for a question with [`~datasets.Dataset.get_nearest_examples`]: |
There was a problem hiding this comment.
It looks like neither format works even though the function - get_nearest_examples - is in the list of [[autodoc]] datasets.Dataset and the path to it is correct.
There was a problem hiding this comment.
I merged master into this branch to update the doc builder app. Hopefully it fixes the issue
There was a problem hiding this comment.
Pinging @sgugger for help as well! 🙌
There was a problem hiding this comment.
Are you sure you have all dependencies installed?
There was a problem hiding this comment.
Hmm using the full path to the method doesn't seem to work either though. For example, when I write [~datasets.arrow_dataset.TensorflowDatasetMixin.to_tf_dataset], it is still displayed without a link (this page for example).
Thanks so much for investigating and this is no rush! 🙂
There was a problem hiding this comment.
Disentangled the mess in this PR. Once it's merged, you should have intra-links that work better for those kinds of methods :-)
There was a problem hiding this comment.
Cool thanks ! I guess it means can have [Dataset.get_nearest_examples] and merge this PR :)
There was a problem hiding this comment.
Yes, you can even check it works on the doc build of this PR beforehand since the PR is merged.
On my tests locally, this particular reference was properly resolved.
There was a problem hiding this comment.
Woo everything looks good now, thanks so much Sylvain! 🥇
stevhliu
force-pushed
the
docs-maintenance
branch
from
9ab6f0a
to
164156b
Compare
This PR links some functions to the API reference. These functions previously only showed up in code format because the path to the actual API was incorrect.