Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Update docs: add hf reranker, fix github links and searchindex links #246

Merged
merged 1 commit into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/api/reranker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,15 @@ CohereReranker
.. autoclass:: CohereReranker
:show-inheritance:
:members:


HFCrossEncoderReranker
========================

.. _hfcrossencoderreranker_api:

.. currentmodule:: redisvl.utils.rerank.hf_cross_encoder

.. autoclass:: HFCrossEncoderReranker
:show-inheritance:
:members:
12 changes: 6 additions & 6 deletions docs/api/searchindex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,27 @@ Search Index Classes

* - Class
- Description
* - `SearchIndex <#searchindex_api>`_
* - :ref:`searchindex_api`
- Primary class to write, read, and search across data structures in Redis.
* - `AsyncSearchIndex <#asyncsearchindex_api>`_
* - :ref:`asyncsearchindex_api`
- Async version of the SearchIndex to write, read, and search across data structures in Redis.

.. _searchindex_api:

SearchIndex
===========

.. _searchindex_api:

.. currentmodule:: redisvl.index

.. autoclass:: SearchIndex
:inherited-members:
:members:

.. _asyncsearchindex_api:

AsyncSearchIndex
================

.. _asyncsearchindex_api:

.. currentmodule:: redisvl.index

.. autoclass:: AsyncSearchIndex
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@
html_logo = "_static/Redis_Favicon_32x32_Red.png"
html_favicon = "_static/Redis_Favicon_32x32_Red.png"
html_context = {
"github_user": "Redis",
"github_repo": "Redis-VL-python",
"github_user": "redis",
"github_repo": "redis-vl-python",
"github_version": "main",
"doc_path": "docs",
}
Expand Down
Loading