From fc19ca9a8fded14c9c6ecb0d309cfc45623826d2 Mon Sep 17 00:00:00 2001 From: Luxferre Date: Fri, 31 Jul 2026 10:05:46 +0300 Subject: [PATCH] readme upd --- README.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 27012d7..2dab8a8 100644 --- a/README.md +++ b/README.md @@ -15,15 +15,7 @@ Hygate is a standalone, single-binary gateway that exposes Tencent's Hunyuan 3 ( ## Installation -Build from source with Go 1.26 or newer: - -``` -make -``` - -This produces `bin/hygate` binary for your architecture. - -Install the latest release straight from the Git repository with `go install`: +You need Go 1.26 or newer. Install the latest release straight from the Git repository with `go install`: ``` go install code.luxferre.top/luxferre/hygate@latest @@ -39,12 +31,14 @@ cd hygate go install . ``` +Alternatively, you can directly build from source by running `make`. This produces `bin/hygate` binary for your architecture. + ## Usage Run the gateway: ``` -./bin/hygate [-port 8080] [-endpoint https://tencent-hy3.hf.space] +hygate [-port 8080] [-endpoint https://tencent-hy3.hf.space] ``` Available flags: @@ -72,6 +66,10 @@ curl http://localhost:8080/v1/chat/completions \ No. The gateway proxies directly to the public Gradio space and does not require authentication. +### Why proxy this particular model? + +Even through the Gradio API, Tencent Hy3 is a very fast and performant model when it comes to agentic tasks. Unfortunately, it still is too big for most people to run locally, at decent speed or at all. This gateway solves this problem for them. + ### Which models are reported? A single model, `hy3`, is advertised via `/v1/models`. @@ -82,7 +80,14 @@ No. The `usage` field is always zero, since the upstream Gradio API does not exp ### Can the upstream endpoint be changed? -Yes, with the `-endpoint` flag. Any HuggingFace Gradio space hosting the compatible `chat` endpoint will work. +Yes, with the `-endpoint` flag. Any HuggingFace Gradio space hosting the compatible `/chat` endpoint will work. + +### Is it compatible with the [Dynagate](https://code.luxferre.top/luxferre/dynagate) LLM gateway? + +Absolutely. Just run Hygate on a separate port (e.g. 8899) and then add the following line to the Dynagate's `models.csv` file: +``` +hy3,-,http://localhost:8899, +``` ## Credits