Current section

Files

Jump to
tinkex mix.exs
Raw

mix.exs

defmodule Tinkex.MixProject do
use Mix.Project
@version "0.3.0"
@source_url "https://github.com/North-Shore-AI/tinkex"
@docs_url "https://hexdocs.pm/tinkex"
def version, do: @version
def project do
[
app: :tinkex,
version: @version,
elixir: "~> 1.18",
start_permanent: Mix.env() == :prod,
escript: [main_module: Tinkex.CLI],
deps: deps(),
docs: docs(),
description: description(),
package: package(),
name: "Tinkex",
source_url: @source_url,
homepage_url: @source_url,
preferred_cli_env: [
dialyzer: :test
]
]
end
# Run "mix help compile.app" to learn about applications.
def application do
[
mod: {Tinkex.Application, []},
extra_applications: [:logger]
]
end
# Run "mix help deps" to learn about dependencies.
defp deps do
[
# HTTP/2 client
{:finch, "~> 0.18"},
# JSON encoding/decoding
{:jason, "~> 1.4"},
# Numerical computing (tensor operations)
{:nx, "~> 0.9"},
# GPU/CPU-accelerated backend for Nx (optional).
# EXLA ships a native library and does not work reliably inside an escript archive;
# keep it compile-time available, but do not start it automatically.
{:exla, "~> 0.9", runtime: false},
# Tokenization (HuggingFace models)
{:tokenizers, "~> 0.5"},
# Tokenization (TikToken-style byte BPE, Kimi K2 compatible)
{:tiktoken_ex, "~> 0.1.0"},
# Telemetry
{:telemetry, "~> 1.2"},
{:semaphore, "~> 1.3"},
# Development
{:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
{:credo, "~> 1.7", only: [:dev, :test], runtime: false},
{:ex_doc, "~> 0.30", only: :dev, runtime: false},
# Regularization primitives
{:nx_penalties, "~> 0.1.2"},
# Testing
{:mox, "~> 1.0", only: :test},
{:bypass, "~> 2.1", only: :test},
{:supertester, "~> 0.3.1", only: :test}
]
end
defp description do
"""
Elixir SDK for Tinker: LoRA training, sampling, and future-based workflows with telemetry and HTTP/2.
"""
end
defp docs do
[
main: "overview",
source_ref: "v#{@version}",
source_url: @source_url,
homepage_url: @docs_url,
assets: %{"assets" => "assets"},
logo: "assets/tinkex.svg",
extras: [
{"README.md", [filename: "overview", title: "Overview"]},
{"CHANGELOG.md", [filename: "changelog", title: "Changelog"]},
{"LICENSE", [filename: "license", title: "License"]},
{"examples/README.md", [filename: "examples", title: "Examples"]},
# Getting Started
"docs/guides/getting_started.md",
"docs/guides/tokenization.md",
"docs/guides/kimi_k2_tokenization.md",
"docs/guides/advanced_configuration.md",
"docs/guides/environment_configuration.md",
"docs/guides/file_uploads.md",
"docs/guides/model_info_unload.md",
# Core Features
"docs/guides/training_loop.md",
"docs/guides/forward_inference.md",
"docs/guides/custom_loss_training.md",
"docs/guides/regularizers.md",
"docs/guides/checkpoint_management.md",
"docs/guides/training_persistence.md",
# Async & Reliability
"docs/guides/futures_and_async.md",
"docs/guides/retry_and_error_handling.md",
"docs/guides/recovery.md",
# Observability
"docs/guides/telemetry.md",
"docs/guides/metrics.md",
"docs/guides/streaming.md",
# Reference
"docs/guides/cli_guide.md",
"docs/guides/api_reference.md",
"docs/guides/troubleshooting.md"
],
groups_for_extras: [
"Getting Started": [
"docs/guides/getting_started.md",
"docs/guides/tokenization.md",
"docs/guides/kimi_k2_tokenization.md",
"docs/guides/advanced_configuration.md",
"docs/guides/environment_configuration.md",
"docs/guides/file_uploads.md",
"docs/guides/model_info_unload.md"
],
"Core Features": [
"docs/guides/training_loop.md",
"docs/guides/forward_inference.md",
"docs/guides/custom_loss_training.md",
"docs/guides/regularizers.md",
"docs/guides/checkpoint_management.md",
"docs/guides/training_persistence.md"
],
"Async & Reliability": [
"docs/guides/futures_and_async.md",
"docs/guides/retry_and_error_handling.md",
"docs/guides/recovery.md"
],
Observability: [
"docs/guides/telemetry.md",
"docs/guides/metrics.md",
"docs/guides/streaming.md"
],
Reference: [
"docs/guides/cli_guide.md",
"docs/guides/api_reference.md",
"docs/guides/troubleshooting.md"
]
]
]
end
defp package do
[
name: "tinkex",
licenses: ["Apache-2.0"],
links: %{
"GitHub" => @source_url,
"Docs" => @docs_url
},
files: ~w(lib mix.exs README.md CHANGELOG.md LICENSE assets docs/guides examples)
]
end
end