From dae983342a679652c4bf03c9a97943f4064bbad3 Mon Sep 17 00:00:00 2001 From: Andrei Betlen Date: Tue, 27 Jun 2023 12:45:31 -0400 Subject: [PATCH] Update docs --- docs/api-reference.md | 37 +++++++++++++++++++++++++++++++++++++ docs/index.md | 36 ------------------------------------ 2 files changed, 37 insertions(+), 36 deletions(-) create mode 100644 docs/api-reference.md diff --git a/docs/api-reference.md b/docs/api-reference.md new file mode 100644 index 0000000..2c5dec1 --- /dev/null +++ b/docs/api-reference.md @@ -0,0 +1,37 @@ +--- +title: API Reference +--- + +::: llama_cpp.Llama + options: + members: + - __init__ + - tokenize + - detokenize + - reset + - eval + - sample + - generate + - create_embedding + - embed + - create_completion + - __call__ + - create_chat_completion + - set_cache + - save_state + - load_state + - token_bos + - token_eos + show_root_heading: true + +::: llama_cpp.LlamaCache + options: + show_root_heading: true + +::: llama_cpp.LlamaState + options: + show_root_heading: true + +::: llama_cpp.llama_cpp + options: + show_if_no_docstring: true \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 99b1f59..7d5ccc3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -87,42 +87,6 @@ git submodule update --init --recursive python3 setup.py develop ``` -## API Reference - -::: llama_cpp.Llama - options: - members: - - __init__ - - tokenize - - detokenize - - reset - - eval - - sample - - generate - - create_embedding - - embed - - create_completion - - __call__ - - create_chat_completion - - set_cache - - save_state - - load_state - - token_bos - - token_eos - show_root_heading: true - -::: llama_cpp.LlamaCache - options: - show_root_heading: true - -::: llama_cpp.LlamaState - options: - show_root_heading: true - -::: llama_cpp.llama_cpp - options: - show_if_no_docstring: true - ## License This project is licensed under the terms of the MIT license. \ No newline at end of file