Skip to content

Commit

Permalink
Update foots (#127)
Browse files Browse the repository at this point in the history
Signed-off-by: Jael Gu <[email protected]>
  • Loading branch information
jaelgu committed Apr 6, 2023
1 parent e6bb7c5 commit e940a2e
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 17 deletions.
1 change: 1 addition & 0 deletions docs/_templates/author.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
By <a href="https://zilliz.com/cloud">Zilliz Inc.</a>
1 change: 1 addition & 0 deletions docs/_templates/copyright.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<p>© Copyright 2023, <a href="https://zilliz.com/cloud">Zilliz Inc.</a></p>
27 changes: 10 additions & 17 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,26 +107,19 @@ To use GPTCache exclusively, only the following lines of code are required, and

More Docs:

- `Usage, how to use GPTCache better <./usage.md>`_
- `Features, all features currently supported by the cache <./feature.md>`_
- `Usage, how to use GPTCache better <./usage.html>`_
- `Features, all features currently supported by the cache <./feature.html>`_
- `Examples, learn better custom caching <https://github.com/zilliztech/GPTCache/tree/main/examples>`_


Usage
-----

GPTCache is easy to understand and can boost your LLM API speed by 100x in just two steps:

1. Build your cache, which includes deciding on embedding functions, similarity evaluation functions, where to store the data, and eviction configurations.
2. Choose your adapter. GPTCache currently supports the OpenAI chatGPT interface and langchain interface. Langchain supports a variety of LLMs, such as Anthropic, Llama-cpp, Huggingface hub, and Cohere.

.. toctree::
:maxdepth: 2
:caption: Usage
:name: usage
:maxdepth: 1
:caption: Getting Started
:name: getting-started
:hidden:

usage
usage.md
feature.md



Modules
Expand Down Expand Up @@ -189,12 +182,12 @@ Contributing

WWe are extremely open to contributions, be it through new features, enhanced infrastructure, or improved documentation.

For comprehensive instructions on how to contribute, please refer to our `contribution guide <docs/contributing.md>`_.
For comprehensive instructions on how to contribute, please refer to our `contribution guide <contributing.html>`_.

.. toctree::
:maxdepth: 1
:caption: Contributing
:name: contributing
:hidden:

contributing
contributing.md

0 comments on commit e940a2e

Please sign in to comment.