avrik-server 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- avrik_server-1.0.0/LICENSE +202 -0
- avrik_server-1.0.0/NOTICE +10 -0
- avrik_server-1.0.0/PKG-INFO +92 -0
- avrik_server-1.0.0/PYPI.md +64 -0
- avrik_server-1.0.0/pyproject.toml +45 -0
- avrik_server-1.0.0/pyproject.toml.orig +28 -0
- avrik_server-1.0.0/src/avrik_server/__init__.py +4 -0
- avrik_server-1.0.0/src/avrik_server/api/__init__.py +1 -0
- avrik_server-1.0.0/src/avrik_server/api/__main__.py +77 -0
- avrik_server-1.0.0/src/avrik_server/api/app.py +143 -0
- avrik_server-1.0.0/src/avrik_server/api/discovery.py +129 -0
- avrik_server-1.0.0/src/avrik_server/api/errors.py +57 -0
- avrik_server-1.0.0/src/avrik_server/api/limits.py +294 -0
- avrik_server-1.0.0/src/avrik_server/api/ratelimit.py +158 -0
- avrik_server-1.0.0/src/avrik_server/api/schemas.py +164 -0
- avrik_server-1.0.0/src/avrik_server/backends/__init__.py +6 -0
- avrik_server-1.0.0/src/avrik_server/backends/base.py +102 -0
- avrik_server-1.0.0/src/avrik_server/backends/llamacpp.py +105 -0
- avrik_server-1.0.0/src/avrik_server/backends/threaded.py +56 -0
- avrik_server-1.0.0/src/avrik_server/backends/transformers_ref.py +125 -0
- avrik_server-1.0.0/src/avrik_server/backends/vllm_http.py +385 -0
- avrik_server-1.0.0/src/avrik_server/bench/__init__.py +6 -0
- avrik_server-1.0.0/src/avrik_server/bench/__main__.py +183 -0
- avrik_server-1.0.0/src/avrik_server/bench/core.py +263 -0
- avrik_server-1.0.0/src/avrik_server/bench/images.py +98 -0
- avrik_server-1.0.0/src/avrik_server/calibration/__init__.py +1 -0
- avrik_server-1.0.0/src/avrik_server/calibration/__main__.py +290 -0
- avrik_server-1.0.0/src/avrik_server/calibration/file.py +159 -0
- avrik_server-1.0.0/src/avrik_server/calibration/fit.py +247 -0
- avrik_server-1.0.0/src/avrik_server/config.py +212 -0
- avrik_server-1.0.0/src/avrik_server/engine/__init__.py +1 -0
- avrik_server-1.0.0/src/avrik_server/engine/corrections.py +102 -0
- avrik_server-1.0.0/src/avrik_server/engine/decide.py +733 -0
- avrik_server-1.0.0/src/avrik_server/engine/policy.py +104 -0
- avrik_server-1.0.0/src/avrik_server/engine/reask.py +38 -0
- avrik_server-1.0.0/src/avrik_server/py.typed +0 -0
- avrik_server-1.0.0/src/avrik_server/readout/__init__.py +8 -0
- avrik_server-1.0.0/src/avrik_server/readout/distribution.py +101 -0
- avrik_server-1.0.0/src/avrik_server/readout/enumerate.py +200 -0
- avrik_server-1.0.0/src/avrik_server/readout/prompt.py +211 -0
- avrik_server-1.0.0/src/avrik_server/readout/smoke.py +352 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
avrik-server
|
|
2
|
+
Copyright 2026 Avrik AI (https://www.avrik.ai)
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (see LICENSE). Distributed on an "AS IS"
|
|
5
|
+
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
|
|
6
|
+
|
|
7
|
+
Avrik models are built on Gemma 4 by Google, licensed under the Apache License,
|
|
8
|
+
Version 2.0. Acceptable use policy: https://huggingface.co/avrik-ai/Avrik-Pro-12B/blob/main/USE_POLICY.md
|
|
9
|
+
|
|
10
|
+
Contact: avriktech.ai@gmail.com
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: avrik-server
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Avrik server: readout, calibration, /v1/systemone API and inference backends.
|
|
5
|
+
Author: Avrik AI
|
|
6
|
+
Author-email: Avrik AI <avriktech.ai@gmail.com>
|
|
7
|
+
License-Expression: Apache-2.0
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
License-File: NOTICE
|
|
10
|
+
Requires-Dist: fastapi>=0.115,<1 ; extra == 'api'
|
|
11
|
+
Requires-Dist: uvicorn>=0.30,<1 ; extra == 'api'
|
|
12
|
+
Requires-Dist: httpx>=0.27,<1 ; extra == 'api'
|
|
13
|
+
Requires-Dist: pydantic>=2.8,<3 ; extra == 'api'
|
|
14
|
+
Requires-Dist: pyyaml>=6.0.3,<7 ; extra == 'api'
|
|
15
|
+
Requires-Dist: llama-cpp-python==0.3.35 ; extra == 'cpu'
|
|
16
|
+
Requires-Dist: numpy>=2.0 ; extra == 'cpu'
|
|
17
|
+
Requires-Dist: transformers>=5.17.0 ; extra == 'readout'
|
|
18
|
+
Requires-Dist: huggingface-hub>=0.30 ; extra == 'readout'
|
|
19
|
+
Maintainer: Avrik AI
|
|
20
|
+
Maintainer-email: Avrik AI <avriktech.ai@gmail.com>
|
|
21
|
+
Requires-Python: >=3.12
|
|
22
|
+
Project-URL: Homepage, https://www.avrik.ai
|
|
23
|
+
Project-URL: Models, https://huggingface.co/avrik-ai
|
|
24
|
+
Provides-Extra: api
|
|
25
|
+
Provides-Extra: cpu
|
|
26
|
+
Provides-Extra: readout
|
|
27
|
+
Description-Content-Type: text/markdown
|
|
28
|
+
|
|
29
|
+
# avrik-server
|
|
30
|
+
|
|
31
|
+
The run-time server for [Avrik](https://huggingface.co/avrik-ai) decision models: the
|
|
32
|
+
prompt renderer, the letter readout, calibration, the `/v1/systemone` HTTP API, and the
|
|
33
|
+
llama.cpp (CPU) and vLLM (GPU) backends.
|
|
34
|
+
|
|
35
|
+
An Avrik model reads a state and typed questions (yes/no, choice, score, multi-label) and
|
|
36
|
+
returns a calibrated probability distribution over each question's options, in one
|
|
37
|
+
forward pass with no generated text.
|
|
38
|
+
|
|
39
|
+
Most people install the [`avrik`](https://pypi.org/project/avrik/) CLI, which depends on
|
|
40
|
+
this package and runs it from a verified model download:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
pip install llama-cpp-python==0.3.35 --no-deps --only-binary=:all: \
|
|
44
|
+
--index-url https://abetlen.github.io/llama-cpp-python/whl/cpu
|
|
45
|
+
pip install "avrik[cpu]"
|
|
46
|
+
avrik pull Avrik-Lite-4B
|
|
47
|
+
avrik serve Avrik-Lite-4B # http://127.0.0.1:8080
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
To call the API from Python, use [`avrik-sdk`](https://pypi.org/project/avrik-sdk/).
|
|
51
|
+
|
|
52
|
+
## What it does
|
|
53
|
+
|
|
54
|
+
1. **Renders** the state and question with a fixed prompt template whose SHA-256 is
|
|
55
|
+
returned with every answer; options are letters A, B, C, ...
|
|
56
|
+
2. **Reads** the probability of every tokenizer form of each option letter (never top-k)
|
|
57
|
+
and refuses the answer if the letters hold less than 98% of the probability mass.
|
|
58
|
+
3. **Calibrates** with per-type temperatures fitted for the exact build, bound to its hash;
|
|
59
|
+
a calibration file for another build is refused.
|
|
60
|
+
4. **Answers** with the distribution, `top`, `margin`, `confidence`, `abstain`, and eight
|
|
61
|
+
audit fields: model hash, adapter hash, calibration version, prompt-template SHA-256,
|
|
62
|
+
allowed-token-set hash, input tokens, backend and precision.
|
|
63
|
+
|
|
64
|
+
## Extras
|
|
65
|
+
|
|
66
|
+
| Extra | Adds |
|
|
67
|
+
| --- | --- |
|
|
68
|
+
| `avrik-server[readout]` | tokenizer and chat template (`transformers`, no PyTorch) |
|
|
69
|
+
| `avrik-server[api]` | the HTTP server (FastAPI, uvicorn, httpx, pydantic) |
|
|
70
|
+
| `avrik-server[cpu]` | the llama.cpp backend (`llama-cpp-python` 0.3.35, numpy) |
|
|
71
|
+
|
|
72
|
+
The GPU backend talks to a vLLM server on loopback started with
|
|
73
|
+
`--logprobs-mode raw_logprobs`; see each model card for the exact command.
|
|
74
|
+
|
|
75
|
+
## Privacy
|
|
76
|
+
|
|
77
|
+
Inference makes no network calls, sends no telemetry and stores nothing. The server
|
|
78
|
+
listens on 127.0.0.1 unless you configure otherwise.
|
|
79
|
+
|
|
80
|
+
## Models
|
|
81
|
+
|
|
82
|
+
| Model | Tier | Hugging Face |
|
|
83
|
+
| --- | --- | --- |
|
|
84
|
+
| Avrik-Lite-4B | Edge (CPU) | [avrik-ai/Avrik-Lite-4B](https://huggingface.co/avrik-ai/Avrik-Lite-4B), [-GGUF](https://huggingface.co/avrik-ai/Avrik-Lite-4B-GGUF) |
|
|
85
|
+
| Avrik-Pro-12B | Pro (default) | [avrik-ai/Avrik-Pro-12B](https://huggingface.co/avrik-ai/Avrik-Pro-12B), [-GGUF](https://huggingface.co/avrik-ai/Avrik-Pro-12B-GGUF) |
|
|
86
|
+
| Avrik-Max-31B | Max | [avrik-ai/Avrik-Max-31B](https://huggingface.co/avrik-ai/Avrik-Max-31B) |
|
|
87
|
+
|
|
88
|
+
Built on Gemma 4 by Google (Apache-2.0). Licence: Apache-2.0. Security reports:
|
|
89
|
+
avriktech.ai@gmail.com.
|
|
90
|
+
|
|
91
|
+
Website: [www.avrik.ai](https://www.avrik.ai) · Models: [huggingface.co/avrik-ai](https://huggingface.co/avrik-ai) ·
|
|
92
|
+
[Acceptable use policy](https://huggingface.co/avrik-ai/Avrik-Pro-12B/blob/main/USE_POLICY.md)
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# avrik-server
|
|
2
|
+
|
|
3
|
+
The run-time server for [Avrik](https://huggingface.co/avrik-ai) decision models: the
|
|
4
|
+
prompt renderer, the letter readout, calibration, the `/v1/systemone` HTTP API, and the
|
|
5
|
+
llama.cpp (CPU) and vLLM (GPU) backends.
|
|
6
|
+
|
|
7
|
+
An Avrik model reads a state and typed questions (yes/no, choice, score, multi-label) and
|
|
8
|
+
returns a calibrated probability distribution over each question's options, in one
|
|
9
|
+
forward pass with no generated text.
|
|
10
|
+
|
|
11
|
+
Most people install the [`avrik`](https://pypi.org/project/avrik/) CLI, which depends on
|
|
12
|
+
this package and runs it from a verified model download:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
pip install llama-cpp-python==0.3.35 --no-deps --only-binary=:all: \
|
|
16
|
+
--index-url https://abetlen.github.io/llama-cpp-python/whl/cpu
|
|
17
|
+
pip install "avrik[cpu]"
|
|
18
|
+
avrik pull Avrik-Lite-4B
|
|
19
|
+
avrik serve Avrik-Lite-4B # http://127.0.0.1:8080
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
To call the API from Python, use [`avrik-sdk`](https://pypi.org/project/avrik-sdk/).
|
|
23
|
+
|
|
24
|
+
## What it does
|
|
25
|
+
|
|
26
|
+
1. **Renders** the state and question with a fixed prompt template whose SHA-256 is
|
|
27
|
+
returned with every answer; options are letters A, B, C, ...
|
|
28
|
+
2. **Reads** the probability of every tokenizer form of each option letter (never top-k)
|
|
29
|
+
and refuses the answer if the letters hold less than 98% of the probability mass.
|
|
30
|
+
3. **Calibrates** with per-type temperatures fitted for the exact build, bound to its hash;
|
|
31
|
+
a calibration file for another build is refused.
|
|
32
|
+
4. **Answers** with the distribution, `top`, `margin`, `confidence`, `abstain`, and eight
|
|
33
|
+
audit fields: model hash, adapter hash, calibration version, prompt-template SHA-256,
|
|
34
|
+
allowed-token-set hash, input tokens, backend and precision.
|
|
35
|
+
|
|
36
|
+
## Extras
|
|
37
|
+
|
|
38
|
+
| Extra | Adds |
|
|
39
|
+
| --- | --- |
|
|
40
|
+
| `avrik-server[readout]` | tokenizer and chat template (`transformers`, no PyTorch) |
|
|
41
|
+
| `avrik-server[api]` | the HTTP server (FastAPI, uvicorn, httpx, pydantic) |
|
|
42
|
+
| `avrik-server[cpu]` | the llama.cpp backend (`llama-cpp-python` 0.3.35, numpy) |
|
|
43
|
+
|
|
44
|
+
The GPU backend talks to a vLLM server on loopback started with
|
|
45
|
+
`--logprobs-mode raw_logprobs`; see each model card for the exact command.
|
|
46
|
+
|
|
47
|
+
## Privacy
|
|
48
|
+
|
|
49
|
+
Inference makes no network calls, sends no telemetry and stores nothing. The server
|
|
50
|
+
listens on 127.0.0.1 unless you configure otherwise.
|
|
51
|
+
|
|
52
|
+
## Models
|
|
53
|
+
|
|
54
|
+
| Model | Tier | Hugging Face |
|
|
55
|
+
| --- | --- | --- |
|
|
56
|
+
| Avrik-Lite-4B | Edge (CPU) | [avrik-ai/Avrik-Lite-4B](https://huggingface.co/avrik-ai/Avrik-Lite-4B), [-GGUF](https://huggingface.co/avrik-ai/Avrik-Lite-4B-GGUF) |
|
|
57
|
+
| Avrik-Pro-12B | Pro (default) | [avrik-ai/Avrik-Pro-12B](https://huggingface.co/avrik-ai/Avrik-Pro-12B), [-GGUF](https://huggingface.co/avrik-ai/Avrik-Pro-12B-GGUF) |
|
|
58
|
+
| Avrik-Max-31B | Max | [avrik-ai/Avrik-Max-31B](https://huggingface.co/avrik-ai/Avrik-Max-31B) |
|
|
59
|
+
|
|
60
|
+
Built on Gemma 4 by Google (Apache-2.0). Licence: Apache-2.0. Security reports:
|
|
61
|
+
avriktech.ai@gmail.com.
|
|
62
|
+
|
|
63
|
+
Website: [www.avrik.ai](https://www.avrik.ai) · Models: [huggingface.co/avrik-ai](https://huggingface.co/avrik-ai) ·
|
|
64
|
+
[Acceptable use policy](https://huggingface.co/avrik-ai/Avrik-Pro-12B/blob/main/USE_POLICY.md)
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "avrik-server"
|
|
3
|
+
version = "1.0.0"
|
|
4
|
+
description = "Avrik server: readout, calibration, /v1/systemone API and inference backends."
|
|
5
|
+
readme = "PYPI.md"
|
|
6
|
+
requires-python = ">=3.12"
|
|
7
|
+
license = "Apache-2.0"
|
|
8
|
+
license-files = [
|
|
9
|
+
"LICENSE",
|
|
10
|
+
"NOTICE",
|
|
11
|
+
]
|
|
12
|
+
dependencies = []
|
|
13
|
+
|
|
14
|
+
[[project.authors]]
|
|
15
|
+
name = "Avrik AI"
|
|
16
|
+
email = "avriktech.ai@gmail.com"
|
|
17
|
+
|
|
18
|
+
[[project.maintainers]]
|
|
19
|
+
name = "Avrik AI"
|
|
20
|
+
email = "avriktech.ai@gmail.com"
|
|
21
|
+
|
|
22
|
+
[project.urls]
|
|
23
|
+
Homepage = "https://www.avrik.ai"
|
|
24
|
+
Models = "https://huggingface.co/avrik-ai"
|
|
25
|
+
|
|
26
|
+
[project.optional-dependencies]
|
|
27
|
+
readout = [
|
|
28
|
+
"transformers>=5.17.0",
|
|
29
|
+
"huggingface_hub>=0.30",
|
|
30
|
+
]
|
|
31
|
+
cpu = [
|
|
32
|
+
"llama-cpp-python==0.3.35",
|
|
33
|
+
"numpy>=2.0",
|
|
34
|
+
]
|
|
35
|
+
api = [
|
|
36
|
+
"fastapi>=0.115,<1",
|
|
37
|
+
"uvicorn>=0.30,<1",
|
|
38
|
+
"httpx>=0.27,<1",
|
|
39
|
+
"pydantic>=2.8,<3",
|
|
40
|
+
"pyyaml>=6.0.3,<7",
|
|
41
|
+
]
|
|
42
|
+
|
|
43
|
+
[build-system]
|
|
44
|
+
requires = ["uv_build>=0.12.1,<0.13.0"]
|
|
45
|
+
build-backend = "uv_build"
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "avrik-server"
|
|
3
|
+
authors = [{ name = "Avrik AI", email = "avriktech.ai@gmail.com" }]
|
|
4
|
+
version = "1.0.0"
|
|
5
|
+
description = "Avrik server: readout, calibration, /v1/systemone API and inference backends."
|
|
6
|
+
readme = "PYPI.md"
|
|
7
|
+
requires-python = ">=3.12"
|
|
8
|
+
license = "Apache-2.0"
|
|
9
|
+
license-files = ["LICENSE", "NOTICE"]
|
|
10
|
+
maintainers = [{ name = "Avrik AI", email = "avriktech.ai@gmail.com" }]
|
|
11
|
+
dependencies = []
|
|
12
|
+
|
|
13
|
+
[project.urls]
|
|
14
|
+
Homepage = "https://www.avrik.ai"
|
|
15
|
+
Models = "https://huggingface.co/avrik-ai"
|
|
16
|
+
|
|
17
|
+
[project.optional-dependencies]
|
|
18
|
+
# Tokenizer and chat template only; no torch (research R4, R10).
|
|
19
|
+
readout = ["transformers>=5.17.0", "huggingface_hub>=0.30"]
|
|
20
|
+
# CPU backend: llama-cpp-python from the CPU wheel index (root pyproject), plus numpy (research R3).
|
|
21
|
+
cpu = ["llama-cpp-python==0.3.35", "numpy>=2.0"]
|
|
22
|
+
# The /v1/systemone server (Phase 2, research R1): validation + OpenAPI 3.1, ASGI server,
|
|
23
|
+
# async loopback client to vLLM.
|
|
24
|
+
api = ["fastapi>=0.115,<1", "uvicorn>=0.30,<1", "httpx>=0.27,<1", "pydantic>=2.8,<3", "pyyaml>=6.0.3,<7"]
|
|
25
|
+
|
|
26
|
+
[build-system]
|
|
27
|
+
requires = ["uv_build>=0.12.1,<0.13.0"]
|
|
28
|
+
build-backend = "uv_build"
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"""The /v1/systemone HTTP service (Step 2.5)."""
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
"""``python -m avrik_server.api --config <server.yaml>``: serve ``/v1/systemone``.
|
|
2
|
+
|
|
3
|
+
Loads the config, the pinned tokenizer (local files only, no network), the backend and
|
|
4
|
+
the calibration file; refuses to start on a mismatched calibration; binds to the
|
|
5
|
+
configured host (loopback unless API keys are set, research R11).
|
|
6
|
+
"""
|
|
7
|
+
|
|
8
|
+
from __future__ import annotations
|
|
9
|
+
|
|
10
|
+
import argparse
|
|
11
|
+
import sys
|
|
12
|
+
from collections.abc import Sequence
|
|
13
|
+
from pathlib import Path
|
|
14
|
+
from typing import Any
|
|
15
|
+
|
|
16
|
+
from avrik_server.config import ServerConfig, load_config
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def build_backend(config: ServerConfig) -> Any: # pragma: no cover - loads real backends
|
|
20
|
+
"""The configured backend, async."""
|
|
21
|
+
b = config.backend
|
|
22
|
+
if b.kind == "vllm-gpu":
|
|
23
|
+
from avrik_server.backends.vllm_http import AsyncVllmHttpBackend
|
|
24
|
+
|
|
25
|
+
return AsyncVllmHttpBackend(
|
|
26
|
+
str(b.url),
|
|
27
|
+
model=b.served_model,
|
|
28
|
+
precision=b.precision,
|
|
29
|
+
timeout=b.timeout,
|
|
30
|
+
full_vocab=b.full_vocab,
|
|
31
|
+
sequential_shards=b.sequential_shards,
|
|
32
|
+
shard_size=b.shard_size,
|
|
33
|
+
)
|
|
34
|
+
from avrik_server.backends.threaded import ThreadedBackend
|
|
35
|
+
|
|
36
|
+
if b.kind == "llamacpp-cpu":
|
|
37
|
+
from avrik_server.backends.llamacpp import LlamaCppBackend
|
|
38
|
+
|
|
39
|
+
return ThreadedBackend(LlamaCppBackend(str(b.gguf), n_ctx=b.max_model_len))
|
|
40
|
+
from avrik_server.backends.transformers_ref import TransformersBackend
|
|
41
|
+
|
|
42
|
+
dtype = "float32" if b.precision == "fp32" else "bfloat16"
|
|
43
|
+
return ThreadedBackend(TransformersBackend(config.model_dir, dtype=dtype))
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
def main(argv: Sequence[str] | None = None) -> int: # pragma: no cover - starts a server
|
|
47
|
+
"""Entry point."""
|
|
48
|
+
parser = argparse.ArgumentParser(prog="python -m avrik_server.api")
|
|
49
|
+
parser.add_argument("--config", type=Path, required=True)
|
|
50
|
+
args = parser.parse_args(argv)
|
|
51
|
+
import uvicorn
|
|
52
|
+
|
|
53
|
+
from avrik_server.api.app import create_app
|
|
54
|
+
from avrik_server.calibration.file import CalibrationError, load
|
|
55
|
+
from avrik_server.engine.decide import Engine
|
|
56
|
+
from avrik_server.readout.smoke import _hf_tokenizer
|
|
57
|
+
|
|
58
|
+
config = load_config(args.config)
|
|
59
|
+
try:
|
|
60
|
+
engine = Engine(
|
|
61
|
+
config, _hf_tokenizer(config.model_dir), build_backend(config), load(config.calibration)
|
|
62
|
+
)
|
|
63
|
+
except CalibrationError as error:
|
|
64
|
+
print(f"refused: {error}", file=sys.stderr)
|
|
65
|
+
return 3
|
|
66
|
+
uvicorn.run(
|
|
67
|
+
create_app(engine),
|
|
68
|
+
host=config.serving.host,
|
|
69
|
+
port=config.serving.port,
|
|
70
|
+
log_level="info",
|
|
71
|
+
access_log=False,
|
|
72
|
+
)
|
|
73
|
+
return 0
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
if __name__ == "__main__": # pragma: no cover
|
|
77
|
+
sys.exit(main())
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
"""The HTTP service (build guide Step 2.5; contracts/systemone-api.md; research R11).
|
|
2
|
+
|
|
3
|
+
``create_app(engine)`` builds the ASGI app around an ``Engine``:
|
|
4
|
+
|
|
5
|
+
* ``POST /v1/systemone``: auth (when keys are set), per-key buckets, the bounded decide
|
|
6
|
+
queue, then the raw body is size-checked (413), parsed (400) and handed to the engine,
|
|
7
|
+
whose refusals become stable JSON errors;
|
|
8
|
+
* ``GET /health``, ``/v1/models``, ``/openapi.json``, ``/llms.txt``: public discovery;
|
|
9
|
+
* every response carries the RateLimit headers; unknown paths answer a JSON 404.
|
|
10
|
+
"""
|
|
11
|
+
|
|
12
|
+
from __future__ import annotations
|
|
13
|
+
|
|
14
|
+
import json
|
|
15
|
+
import re
|
|
16
|
+
import uuid
|
|
17
|
+
from collections.abc import Awaitable, Callable
|
|
18
|
+
from typing import Any
|
|
19
|
+
|
|
20
|
+
from fastapi import FastAPI, Request, Response
|
|
21
|
+
from fastapi.responses import JSONResponse, PlainTextResponse
|
|
22
|
+
from starlette.exceptions import HTTPException as StarletteHTTPException
|
|
23
|
+
|
|
24
|
+
from avrik_server.api import discovery
|
|
25
|
+
from avrik_server.api.errors import ApiError
|
|
26
|
+
from avrik_server.api.ratelimit import Limiter, RetryAfter
|
|
27
|
+
from avrik_server.engine.decide import Engine
|
|
28
|
+
|
|
29
|
+
REQUEST_ID = re.compile(r"[A-Za-z0-9._-]{1,64}")
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
async def read_capped(request: Request, limit: int) -> bytes:
|
|
33
|
+
"""The body, refused as soon as it passes ``limit`` bytes (chunked bodies too; T056 B1).
|
|
34
|
+
|
|
35
|
+
Raises:
|
|
36
|
+
ApiError: ``body_too_large``.
|
|
37
|
+
"""
|
|
38
|
+
chunks: list[bytes] = []
|
|
39
|
+
size = 0
|
|
40
|
+
async for chunk in request.stream():
|
|
41
|
+
size += len(chunk)
|
|
42
|
+
if size > limit:
|
|
43
|
+
raise ApiError("body_too_large", f"bodies are limited to {limit} bytes")
|
|
44
|
+
chunks.append(chunk)
|
|
45
|
+
return b"".join(chunks)
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
def create_app(engine: Engine, limiter: Limiter | None = None) -> FastAPI:
|
|
49
|
+
"""The ASGI app serving ``engine``."""
|
|
50
|
+
app = FastAPI(
|
|
51
|
+
title="Avrik decision API",
|
|
52
|
+
version="1.0.0",
|
|
53
|
+
openapi_url=None,
|
|
54
|
+
docs_url=None,
|
|
55
|
+
redoc_url=None,
|
|
56
|
+
)
|
|
57
|
+
app.state.engine = engine
|
|
58
|
+
limits = limiter or Limiter(engine.config.serving)
|
|
59
|
+
max_body = engine.config.limits.max_body_bytes
|
|
60
|
+
|
|
61
|
+
def error_response(error: ApiError, who: str | None = None) -> JSONResponse:
|
|
62
|
+
response = JSONResponse(error.body(), status_code=error.status)
|
|
63
|
+
if isinstance(error, RetryAfter):
|
|
64
|
+
response.headers["Retry-After"] = str(error.retry_after)
|
|
65
|
+
response.headers.update(limits.headers(who))
|
|
66
|
+
return response
|
|
67
|
+
|
|
68
|
+
@app.exception_handler(ApiError)
|
|
69
|
+
async def api_error(_: Request, error: ApiError) -> JSONResponse:
|
|
70
|
+
return error_response(error)
|
|
71
|
+
|
|
72
|
+
@app.exception_handler(StarletteHTTPException)
|
|
73
|
+
async def http_error(_: Request, error: StarletteHTTPException) -> JSONResponse:
|
|
74
|
+
code = "not_found" if error.status_code == 404 else "invalid_request"
|
|
75
|
+
body = {"error": {"code": code, "message": str(error.detail), "field": None}}
|
|
76
|
+
response = JSONResponse(body, status_code=error.status_code)
|
|
77
|
+
response.headers.update(limits.headers(None))
|
|
78
|
+
return response
|
|
79
|
+
|
|
80
|
+
@app.middleware("http")
|
|
81
|
+
async def rate_headers(
|
|
82
|
+
request: Request, call_next: Callable[[Request], Awaitable[Response]]
|
|
83
|
+
) -> Response:
|
|
84
|
+
response = await call_next(request)
|
|
85
|
+
for name, value in limits.headers(getattr(request.state, "who", None)).items():
|
|
86
|
+
response.headers.setdefault(name, value)
|
|
87
|
+
given = request.headers.get("x-request-id", "")
|
|
88
|
+
safe = bool(REQUEST_ID.fullmatch(given)) # echo a client id only if it is plain
|
|
89
|
+
response.headers.setdefault("X-Request-Id", given if safe else uuid.uuid4().hex)
|
|
90
|
+
return response
|
|
91
|
+
|
|
92
|
+
@app.post("/v1/systemone")
|
|
93
|
+
async def systemone(request: Request) -> JSONResponse:
|
|
94
|
+
client = request.client.host if request.client else "unknown"
|
|
95
|
+
who = limits.identify(request.headers.get("authorization"), client)
|
|
96
|
+
request.state.who = who
|
|
97
|
+
try:
|
|
98
|
+
limits.charge(who)
|
|
99
|
+
except ApiError as error:
|
|
100
|
+
return error_response(error, who)
|
|
101
|
+
declared = request.headers.get("content-length")
|
|
102
|
+
if declared is not None and declared.isdigit() and int(declared) > max_body:
|
|
103
|
+
raise ApiError("body_too_large", f"bodies are limited to {max_body} bytes")
|
|
104
|
+
raw = await read_capped(request, max_body)
|
|
105
|
+
try:
|
|
106
|
+
body: Any = json.loads(raw)
|
|
107
|
+
except ValueError as error:
|
|
108
|
+
reason = getattr(error, "msg", "undecodable bytes")
|
|
109
|
+
raise ApiError("bad_json", f"the body is not valid JSON: {reason}") from error
|
|
110
|
+
try:
|
|
111
|
+
await limits.acquire()
|
|
112
|
+
except ApiError as error:
|
|
113
|
+
return error_response(error, who)
|
|
114
|
+
try:
|
|
115
|
+
result = await engine.decide(body, tenant=who)
|
|
116
|
+
finally:
|
|
117
|
+
limits.release()
|
|
118
|
+
response = JSONResponse(result)
|
|
119
|
+
response.headers.update(limits.headers(who))
|
|
120
|
+
return response
|
|
121
|
+
|
|
122
|
+
@app.get("/health")
|
|
123
|
+
async def health() -> JSONResponse:
|
|
124
|
+
ok = await engine.backend.health()
|
|
125
|
+
return JSONResponse(discovery.health(engine, ok), status_code=200 if ok else 503)
|
|
126
|
+
|
|
127
|
+
@app.get("/v1/models")
|
|
128
|
+
async def models() -> JSONResponse:
|
|
129
|
+
return JSONResponse(discovery.models(engine))
|
|
130
|
+
|
|
131
|
+
spec: dict[str, Any] = {}
|
|
132
|
+
|
|
133
|
+
@app.get("/openapi.json")
|
|
134
|
+
async def openapi() -> JSONResponse:
|
|
135
|
+
if not spec: # built once (T056 N1)
|
|
136
|
+
spec.update(discovery.openapi(app))
|
|
137
|
+
return JSONResponse(spec)
|
|
138
|
+
|
|
139
|
+
@app.get("/llms.txt")
|
|
140
|
+
async def llms() -> PlainTextResponse:
|
|
141
|
+
return PlainTextResponse(discovery.LLMS_TXT)
|
|
142
|
+
|
|
143
|
+
return app
|