mirror of
https://github.com/imartinez/privateGPT.git
synced 2025-08-17 15:06:56 +00:00
36f69eed0f
* Refactor documentation architecture Split into several `tab` and sections * Fix Fern's docs.yml after PR review Thank you Danny! Co-authored-by: dannysheridan <danny@buildwithfern.com> * Re-add quickstart in the overview tab It went missing after a refactoring of the doc architecture * Documentation writing * Adapt Makefile to fern documentation * Do not create overlapping page names in fern documentation This is causing 500. Thank you to @dsinghvi for the troubleshooting and the help! * Add a readme to help to understand how fern documentation work and how to add new pages * Rework the welcome view Redirects directly users to installation guide with links for people that are not familiar with documentation browsing. * Simplify the quickstart guide * PR feedback on installation guide A ton of refactoring can still be made there * PR feedback on ingestion * PR feedback on ingestion splitting * Rename section on LLM * Fix missing word in list of LLMs --------- Co-authored-by: dannysheridan <danny@buildwithfern.com>
22 lines
880 B
Plaintext
22 lines
880 B
Plaintext
## Local Installation steps
|
|
|
|
The steps in [Installation](/installation) section are better explained and cover more
|
|
setup scenarios (macOS, Windows, Linux).
|
|
But if you like one-liners, have python3.11 installed, and you are running a UNIX (macOS or Linux)
|
|
system, you can get up and running on CPU in few lines:
|
|
|
|
```bash
|
|
git clone https://github.com/imartinez/privateGPT && cd privateGPT && \
|
|
python3.11 -m venv .venv && source .venv/bin/activate && \
|
|
pip install --upgrade pip poetry && poetry install --with ui,local && ./scripts/setup
|
|
|
|
# Launch the privateGPT API server **and** the gradio UI
|
|
python3.11 -m private_gpt
|
|
|
|
# In another terminal, create a new browser window on your private GPT!
|
|
open http:////127.0.0.1:8001/
|
|
```
|
|
|
|
The above is not working, or it is too slow, so **you want to run it on GPU(s)**?
|
|
Please check the more detailed [installation guide](/installation).
|