Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,10 @@ We disable background uploads by disabling telemetry for huggingface, gradio, an

`generate.py` by default runs a gradio server, which also gives access to client API using gradio client. See example [test code](client_test.py) or other tests in our [tests](https://github.com/h2oai/h2ogpt/blob/main/tests/test_client_calls.py). Any element in [gradio_runner.py](gradio_runner.py) with `api_name` defined can be accessed via the gradio client.

#### Python Client Library

An OpenAI compliant client is available. Refer the [README](client/README.md) for more details.

#### Python Wheel

The wheel adds all dependencies except specialized dependencies like 4-bit and flash-attention. For GPU build do:
Expand Down
164 changes: 164 additions & 0 deletions client/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
### Generated files ###
enums.py

### Python template
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
.idea/
25 changes: 25 additions & 0 deletions client/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
PACKAGE_NAME := $(firstword $(shell poetry version))
PACKAGE_DIR := $(subst -,_,$(PACKAGE_NAME))
PACKAGE_VERSION := $(shell poetry version --short)

generate_sources:
cp -f ./../enums.py "$(PACKAGE_DIR)/enums.py"

.PHONY: setup
setup:
poetry install

.PHONY: lint
lint: generate_sources
poetry run black .
poetry run isort .
poetry run flake8 "$(PACKAGE_DIR)" "tests" || true
poetry run mypy --show-error-codes --pretty .

.PHONY: test
test: generate_sources
poetry run pytest

.PHONY: build
build: generate_sources
poetry build
41 changes: 41 additions & 0 deletions client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# h2oGPT Client
A Python thin-client for h2oGPT.

## Usage
```python
from h2ogpt_client import Client

client = Client("http://0.0.0.0:7860")

# text completion
response = client.text_completion.create("Hello world")
response = await client.text_completion.create_async("Hello world")

# chat completion
chat_context = client.chat_completion.create()
chat = chat_context.chat("Hey!")
print(chat["user"]) # prints user prompt, i.e. "Hey!"
print(chat["gpt"]) # prints reply of the h2oGPT
chat_history = chat_context.chat_history()
```
:warning: **Note**: Client APIs are still evolving. Hence, APIs can be changed without prior warnings.

## Development
### Prerequisites
- Python 3.8
- [Poetry](https://python-poetry.org/docs/#installation) - A dependency management and packaging tool for Python

### Setup environment
```shell
make setup
```

### Run lint
```shell
make lint
```

### Build
```shell
make build
```
4 changes: 4 additions & 0 deletions client/h2ogpt_client/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from h2ogpt_client.core import Client
from h2ogpt_client.enums import LangChainMode, PromptType

__all__ = ["Client", "PromptType", "LangChainMode"]
Loading