Skip to content

Commit

Permalink
fix the doc compile failture as it misses faiss
Browse files Browse the repository at this point in the history
  • Loading branch information
liyin2015 committed Jul 6, 2024
1 parent c20e0b1 commit 1de8eb0
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Documentation
on:
push:
branches:
- release # Trigger the workflow when changes are pushed to the release branch
- li # Trigger the workflow when changes are pushed to the release branch

permissions:
contents: write
Expand Down
29 changes: 19 additions & 10 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,6 @@
:alt: LightRAG Logo


.. raw:: html

<h1 style="text-align: center; font-size: 2em; margin-top: 10px;">⚡ The PyTorch Library for Large Language Model Applications ⚡</h1>

*LightRAG* helps developers with both building and optimizing *Retriever-Agent-Generator (RAG)* pipelines.
It is *light*, *modular*, and *robust*.




.. |License| image:: https://img.shields.io/github/license/SylphAI-Inc/LightRAG
:target: https://opensource.org/license/MIT

Expand Down Expand Up @@ -44,6 +34,25 @@ It is *light*, *modular*, and *robust*.
<a href="https://discord.gg/zt2mTPcu"><img src="https://dcbadge.vercel.app/api/server/zt2mTPcu?compact=true&style=flat" alt="Discord"></a>
</div>

.. raw:: html

<h1 style="text-align: center; font-size: 2em; margin-top: 10px;">⚡ The PyTorch Library for Large Language Model Applications ⚡</h1>

<div style="text-align: center;">
<p>
<em>LightRAG</em> helps developers with both building and optimizing <em>Retriever-Agent-Generator (RAG)</em> pipelines.<br>
It is <em>light</em>, <em>modular</em>, and <em>robust</em>.
</p>
</div>

.. *LightRAG* helps developers with both building and optimizing *Retriever-Agent-Generator (RAG)* pipelines.
.. It is *light*, *modular*, and *robust*.
.. grid:: 1
:gutter: 1

Expand Down
41 changes: 40 additions & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ pandoc = "^2.3"
readthedocs-sphinx-search = "^0.3.2"
sqlalchemy = "^2.0.31"
google-generativeai = "^0.7.1"
faiss-cpu = "^1.8.0.post1"


[build-system]
Expand Down

0 comments on commit 1de8eb0

Please sign in to comment.