feat(python): add native distribution and release infrastructure
- add the Rust-backed Python API with PyStemmer compatibility - distribute standard compiled models as a separate Python package - generate model artifacts during builds instead of storing them in Git - add GitHub release and Pages-backed package index workflows - add Python tests, benchmarks, documentation, and Gradle integration - refresh the documentation site, branding, and language benchmarks
This commit is contained in:
34
docs/getting-started.md
Normal file
34
docs/getting-started.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Get Started with Radixor
|
||||
|
||||
Radixor provides first-class Java and Python runtimes over the same learned
|
||||
patch-command model. Choose the environment that matches the application; both
|
||||
use the maintained language catalog and can exchange compiled version 7 tries.
|
||||
|
||||
## Python
|
||||
|
||||
Choose Python for native CPython integration, efficient batch calls, and a
|
||||
PyStemmer-compatible migration surface.
|
||||
|
||||
```bash
|
||||
python -m pip install radixor
|
||||
```
|
||||
|
||||
- [Python Fast Track](python/fast-track.md) — install and produce the first stem.
|
||||
- [Python Quick Start](python/quick-start.md) — build an application workflow.
|
||||
- [Python Usage and API](python/usage.md) — scalar, batch, cache, and custom-model APIs.
|
||||
|
||||
## Java
|
||||
|
||||
Choose Java for JVM integration, selectable reduction modes, registry-based
|
||||
model discovery, and extending or persisting compiled tries.
|
||||
|
||||
- [Java Fast Track](fast-track.md) — add the core/model dependencies and produce the first stem.
|
||||
- [Java Quick Start](quick-start.md) — loading, querying, extension, and persistence.
|
||||
- [Java Integration Deep Dive](integration-deep-dive.md) — lifecycle and production guidance.
|
||||
|
||||
## Shared concepts
|
||||
|
||||
- [Built-in Languages](built-in-languages.md) documents aliases, model IDs, and defaults.
|
||||
- [Dictionary Format](dictionary-format.md) defines the common source semantics.
|
||||
- [Benchmarks](benchmarks/index.md) separates runtime speed from linguistic quality.
|
||||
- [Architecture](architecture.md) explains shared behavior and runtime-specific internals.
|
||||
Reference in New Issue
Block a user