From bf36c4ddc540805c486d56c6f019f156ca743944 Mon Sep 17 00:00:00 2001 From: emrgnt-cmplxty <68796651+emrgnt-cmplxty@users.noreply.github.com> Date: Tue, 31 Oct 2023 10:39:50 -0400 Subject: [PATCH] Feature/try rst cleanup (#118) * last doc cleanups * cleanup and ready for release --- README.md | 4 --- docs/source/api/main.rst | 65 ++++++++++++++++++++-------------------- docs/source/index.rst | 2 +- pyproject.toml | 2 +- 4 files changed, 34 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 06ce0e8..1487919 100644 --- a/README.md +++ b/README.md @@ -289,10 +289,6 @@ Note: The same dependencies available with pip installation are also available h - `accelerate`: `^0.23.0` - `datasets`: `^2.14.5` - `transformers`: `^4.33.1` -- **Llama-Index**: - - `llama-index`: `^0.8.29.post1` -- **Llama-CPP**: - - `llama-cpp-python`: `^0.2.11` - **VLLM Tools**: - `vllm`: `0.2.0` --- diff --git a/docs/source/api/main.rst b/docs/source/api/main.rst index 8b8f7a9..06a523c 100644 --- a/docs/source/api/main.rst +++ b/docs/source/api/main.rst @@ -17,7 +17,7 @@ Search Endpoint - **URL**: ``/search`` - **Method**: ``POST`` -- **Description**: This endpoint interacts with the Retriever module of the SciPhi codebase, allowing you to search for related documents based on the provided queries. +- **Description**: This endpoint interacts with the Retriever module of the SciPhi-Infra codebase, allowing you to search for related documents based on the provided queries. **Request Body**: - ``queries``: A list of query strings for which related documents should be retrieved. @@ -35,7 +35,7 @@ A list of lists containing Document objects, where each list corresponds to the -H "Content-Type: application/json" \ -d '{"queries": ["What is general relativity?", "Who is Albert Einstein?"], "top_k": 5}' -This request queries the SciPhi World Database. The expected response is: +The expected response is: .. code-block:: none @@ -51,42 +51,41 @@ SciPhi adheres to the API specification of OpenAI's API, allowing compatibility .. code-block:: bash -curl https://api.sciphi.ai/v1/completions \ - -H "Content-Type: application/json" \ - -H "Authorization: Bearer 55c51253002ed4f7d1dd3afbe2a72635" \ - -d '{ - "model": "SciPhi/SciPhi-Self-RAG-Mistral-7B-32k", - "prompt": "Say this is a test.", - "temperature": 0.7 - }' + curl https://api.sciphi.ai/v1/completions \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $SCIPHI_API_KEY" \ + -d '{ + "model": "SciPhi/SciPhi-Self-RAG-Mistral-7B-32k", + "prompt": "Say this is a test.", + "temperature": 0.7 + }' - -After executing the above request with the SciPhi/SciPhi-Self-RAG-Mistral-7B-32k model, the expected response is: +The expected response is: .. code-block:: json -{ - "id":"cmpl-f03f53c15a174ffe89bdfc83507de7a9", - "object":"text_completion", - "created":1698730137, - "model":"SciPhi/SciPhi-Self-RAG-Mistral-7B-32k", - "choices":[ - { - "index":0, - "text":"This is a test.", - "logprobs":null, - "finish_reason":"length" - } - ], - "usage": - { - "prompt_tokens":7, - "total_tokens":23, - "completion_tokens":16 - } -} (base) ocolegrove@MacBook-Pro-5 sciphi-core % + { + "id":"cmpl-f03f53c15a174ffe89bdfc83507de7a9", + "object":"text_completion", + "created":1698730137, + "model":"SciPhi/SciPhi-Self-RAG-Mistral-7B-32k", + "choices":[ + { + "index":0, + "text":"This is a test.", + "logprobs":null, + "finish_reason":"length" + } + ], + "usage": + { + "prompt_tokens":7, + "total_tokens":15, + "completion_tokens":8 + } + } API Key and Signup ------------------ -To access the SciPhi API, you need an API key. If you don't possess one, you can sign up `here `_. Ensure you include the API key in your request headers as shown in the examples. +To access the SciPhi API, you need an API key. If you don't possess one, you can sign up `here `_. Ensure you include the API key in your request headers as shown in the examples. \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 5f00a9e..09ee263 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -26,7 +26,7 @@ SciPhi is a powerful knowledge engine tailored for LLM-based inference, data gen With SciPhi, you can: -* Tap into the **Retriever-Augmented Generation (RAG)** for data anchoring to real-world sources. +* Leverage **Retriever-Augmented Generation (RAG)** for better accuracy and efficiency. - Features like end-to-end cloud and local RAG knowledge engine APIs are underway! * Generate truthful datasets using various LLMs, supporting **Anthropic**, **OpenAI**, **vLLM**, and **SciPhi**. * Custom tailor your data creation for applications such as LLM training, RAG, and beyond. diff --git a/pyproject.toml b/pyproject.toml index d3d4872..6b1de24 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ write_to = "sciphi/_version.py" [tool.poetry] name = "sciphi" -version = "0.1.6" +version = "0.1.7" description = "SciPhi: A Framework for LLM Powered Data." authors = ["Owen Colegrove "] license = "Apache-2.0"