Metadata-Version: 2.4
Name: enigma-turbo-model
Version: 0.2.2
Summary: Model files for enigma-api-client's experimental TurboStrategy, which writes GraphQL queries without an LLM call
Author-email: Enigma Technologies <info@enigma.com>
License-Expression: Apache-2.0 AND MIT
Project-URL: Homepage, https://www.enigma.com/
Project-URL: Documentation, https://documentation.enigma.com/guides/python-sdk/quickstart/
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE-ETTIN
Dynamic: license-file

# enigma-turbo-model

This package is the model that the experimental `TurboStrategy` in the Enigma Python SDK, [`enigma-api-client`](https://pypi.org/project/enigma-api-client/), runs on your machine to turn a question into a GraphQL query for the Enigma API without an LLM call. Install it through the SDK's `turbo` extra, which also installs the runtime it needs:

```bash
pip install "enigma-api-client[turbo]"
```

The Python SDK guide's [TurboStrategy](https://documentation.enigma.com/guides/python-sdk/questions/#turbostrategy) section shows how to use the strategy, and its [Choose a strategy](https://documentation.enigma.com/guides/python-sdk/questions/#choose-a-strategy) section gives the time each strategy takes to write a query.

The package installs one folder holding these data files:

- `model.onnx`: a 32M-parameter encoder fine-tuned from Ettin (`jhu-clsp/ettin-encoder-32m`), with int8 weights for ONNX Runtime.
- `tokenizer.json`: Ettin's tokenizer.
- `meta.json`: the templates and fields the model gives, in its output order.
- `city_state.json`: US city names with their states and populations, from the US Census Bureau's Vintage 2024 population estimates for places of 5,000 people or more.
- `words.txt`: the web2 word list (Webster's Second International Dictionary, 1934), which splits a website's domain into words.

Each SDK release pins the model and ONNX Runtime versions its tests check. The model gives the same replies on the x86 CPUs with AVX-512 it was tested on; other CPUs, ARM and x86 without AVX-512 among them, can reply differently to some prompts.

## License

The package is licensed under the Apache License 2.0 (`LICENSE`). `model.onnx` and `tokenizer.json` derive from Ettin, licensed under the MIT License (`LICENSE-ETTIN`). `city_state.json` derives from US Census Bureau data, a work of the US government. The web2 list's supplier states that its 1934 copyright has lapsed.
