summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTekky <98614666+xtekky@users.noreply.github.com>2023-09-17 23:24:04 +0200
committerGitHub <noreply@github.com>2023-09-17 23:24:04 +0200
commita1d000ea3b3625702c385d69557c3d9f80712237 (patch)
tree90b6ab77ab6c4c53eb2ac1688178638e22be90d7 /README.md
parent~ | Merge pull request #907 from MIDORIBIN/fix-type-hint (diff)
parentRevert "Fix type hint" (diff)
downloadgpt4free-a1d000ea3b3625702c385d69557c3d9f80712237.tar
gpt4free-a1d000ea3b3625702c385d69557c3d9f80712237.tar.gz
gpt4free-a1d000ea3b3625702c385d69557c3d9f80712237.tar.bz2
gpt4free-a1d000ea3b3625702c385d69557c3d9f80712237.tar.lz
gpt4free-a1d000ea3b3625702c385d69557c3d9f80712237.tar.xz
gpt4free-a1d000ea3b3625702c385d69557c3d9f80712237.tar.zst
gpt4free-a1d000ea3b3625702c385d69557c3d9f80712237.zip
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 968743f3..98757e56 100644
--- a/README.md
+++ b/README.md
@@ -145,7 +145,7 @@ import g4f
print(g4f.Provider.Ails.params) # supported args
-# Automatic selection of Provider
+# Automatic selection of provider
# streamed completion
response = g4f.ChatCompletion.create(
@@ -166,7 +166,7 @@ response = g4f.ChatCompletion.create(
print(response)
-# Set with Provider
+# Set with provider
response = g4f.ChatCompletion.create(
model="gpt-3.5-turbo",
provider=g4f.Provider.DeepAi,
@@ -474,8 +474,8 @@ if __name__ == "__main__":
to add another provider, its very simple:
-1. create a new file in [g4f/Provider](./g4f/Provider) with the name of the Provider
-2. Implement a class that extends [BaseProvider](./g4f/Provider/base_provider.py).
+1. create a new file in [g4f/provider](./g4f/provider) with the name of the Provider
+2. Implement a class that extends [BaseProvider](./g4f/provider/base_provider.py).
```py
from .base_provider import BaseProvider
@@ -499,7 +499,7 @@ class HogeService(BaseProvider):
3. Here, you can adjust the settings, for example if the website does support streaming, set `working` to `True`...
4. Write code to request the provider in `create_completion` and `yield` the response, _even if_ its a one-time response, do not hesitate to look at other providers for inspiration
-5. Add the Provider Name in [g4f/provider/\_\_init__.py](./g4f/Provider/__init__.py)
+5. Add the Provider Name in [g4f/provider/**init**.py](./g4f/provider/__init__.py)
```py
from .base_provider import BaseProvider