Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Commit

Permalink
cleanup docs
Browse files Browse the repository at this point in the history
  • Loading branch information
emrgnt-cmplxty committed Dec 15, 2023
1 parent c6f15fa commit 25c982f
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ With Synthesizer, users can:
- **Retrieval-Augmented Generation (RAG) on Demand**: Built-in RAG Provider Interface to anchor generated data to real-world sources.
- Turnkey integration with Agent Search API.
- **Custom Data Creation**: Generate datasets via LLMs that are tailored to your needs, for LLM training, RAG, and more.
- _Included Example_ - A dedicated textbook module which writes RAG-enhanced textbooks directly from a provided table of contents.

---

Expand Down
7 changes: 4 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Welcome to Synthesizer 💡
.. raw:: html

<p style="text-align:center">
<strong>AI's Knowledge Engine.
</strong>
</p>

Expand All @@ -24,6 +23,8 @@ Welcome to Synthesizer 💡

A multi-purpose LLM framework for inference, RAG, and data creation.

Looking for the AgentSearch documentation? `Click Here <agent-search.readthedocs.io>`.

With Synthesizer, you can:

* Leverage **Retrieval-Augmented Generation (RAG)** for better accuracy and efficiency.
Expand All @@ -34,8 +35,8 @@ With Synthesizer, you can:

Quick and easy setup:

* Installation with pip: ``pip install sciphi``
* Optional dependencies are available for extended functionality, such as ``sciphi[all_with_extras]`` for additional integrations.
* Installation with pip: ``pip install synthesizer``
* Optional dependencies are available for extended functionality, such as ``synthesizer[all_with_extras]`` for additional integrations.

Diverse Features:

Expand Down
3 changes: 1 addition & 2 deletions docs/source/setup/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _synthesizer_quickstart:

Synthesizer Quickstart
=================
======================

Welcome to the Synthesizer quickstart guide! Synthesizer, or ΨΦ, is your portal to combining Retrieval-Augmented Generation (RAG) with large language models (LLMs) like OpenAI's models, Anthropic, HuggingFace, and vLLM.

Expand Down Expand Up @@ -74,4 +74,3 @@ Here's how you can use Synthesizer to quickly set up and retrieve chat completio
# Fermat's Last Theorem was proven by British mathematician Andrew Wiles in 1994 (Wikipedia). Wiles's proof was based on a special case of the modularity theorem for elliptic curves, along with Ribet's theorem (Wikipedia). The modularity theorem and Fermat's Last Theorem were previously considered inaccessible to proof by contemporaneous mathematicians (Wikipedia). However, Wiles's proof provided a solution to Fermat's Last Theorem, which had remained unproved for over 300 years (PlanetMath). Wiles's proof is widely accepted and has been recognized with numerous awards, including the Abel Prize in 2016 (Wikipedia).
# It is important to note that Wiles's proof of Fermat's Last Theorem is a mathematical proof and not related to the science fiction novel "The Last Theorem" by Arthur C. Clarke and Frederik Pohl (Wikipedia). The novel is a work of fiction and does not provide a real mathematical proof for Fermat's Last Theorem (Wikipedia). Additionally, there have been other attempts to prove Fermat's Last Theorem, such as Sophie Germain's approach, but Wiles's proof is the most widely accepted and recognized (Math Stack Exchange).
---

0 comments on commit 25c982f

Please sign in to comment.