Improvements to documentation (#606)

This commit is contained in:
Richard Guo 2023-05-16 15:29:27 -04:00 committed by GitHub
parent bc481f2ab7
commit e659ef5b2a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 9 deletions

View File

@ -13,6 +13,8 @@ pip install gpt4all
## Local Build Instructions
**NOTE**: If you are doing this on a Windows machine, you must build the GPT4All backend using [MinGW64](https://www.mingw-w64.org/) compiler.
1. Setup `llmodel`
```

View File

@ -11,7 +11,7 @@ pip install gpt4all
In Python, run the following commands to retrieve a GPT4All model and generate a response
to a prompt.
**Download Note*:**
**Download Note:**
By default, models are stored in `~/.cache/gpt4all/` (you can change this with `model_path`). If the file already exists, model download will be skipped.
```python

View File

@ -4,6 +4,7 @@ Python only API for running all GPT4All models.
import json
import os
from pathlib import Path
import time
from typing import Dict, List
import requests
@ -148,6 +149,8 @@ class GPT4All():
raise RuntimeError(
"An error occurred during download. Downloaded file may not work."
)
# Sleep for a little bit so OS can remove file lock
time.sleep(2)
print("Model downloaded at: " + download_path)
return download_path

View File

@ -1,7 +1,7 @@
site_name: GPT4All Documentation
repo_url: https://github.com/nomic-ai/gpt4all
repo_name: nomic-ai/gpt4all
site_url: https://docs.nomic.ai # TODO: change
site_url: https://docs.gpt4all.io
edit_uri: edit/main/docs/
site_description: Documentation for running GPT4All anywhere.
copyright: Copyright © 2023 Nomic, Inc
@ -66,9 +66,3 @@ plugins:
#- mkdocs-jupyter:
# ignore_h1_titles: True
# show_input: True
extra:
generator: false
analytics:
provider: google
property: G-NPXC8BYHJV