Packages

SentenceTransformers pipelines for Elixir and Bumblebee

Current section

Files

Jump to
sting mix.exs
Raw

mix.exs

defmodule Sting.MixProject do
  use Mix.Project

  @version "0.1.0"
  @source_url "https://github.com/dkuku/sting"
  @description "SentenceTransformers pipelines for Elixir and Bumblebee"

  def project do
    [
      app: :sting,
      version: @version,
      elixir: "~> 1.17",
      name: "Sting",
      source_url: @source_url,
      homepage_url: @source_url,
      docs: docs(),
      elixirc_paths: elixirc_paths(Mix.env()),
      description: @description,
      package: package(),
      start_permanent: Mix.env() == :prod,
      deps: deps()
    ]
  end

  defp elixirc_paths(:test), do: ["lib", "test/support"]
  defp elixirc_paths(_), do: ["lib"]

  def application do
    [
      extra_applications: [:logger]
    ]
  end

  defp deps do
    [
      bumblebee_dep(),
      {:axon, "~> 0.9.0"},
      {:nx, "~> 1.0"},
      {:tokenizers, "~> 0.5.0"},
      {:safetensors, "~> 0.2.0"},
      {:jason, "~> 1.4"},
      {:styler, "~> 1.0", only: [:dev, :test], runtime: false},
      {:exla, "~> 1.0", only: [:dev, :test]},
      {:torchx, "~> 1.0", only: [:dev, :test]},
      {:ex_doc, "~> 0.40", only: :dev, runtime: false}
    ]
  end

  defp bumblebee_dep do
    if path = System.get_env("BUMBLEBEE_PATH") do
      {:bumblebee, path: path}
    else
      {:bumblebee, "~> 0.8.0"}
    end
  end

  defp package do
    [
      files: ~w(lib guides mix.exs README.md CHANGELOG.md LICENSE),
      licenses: ["Apache-2.0"],
      links: %{
        "GitHub" => @source_url
      }
    ]
  end

  defp docs do
    [
      main: "readme",
      source_ref: "v#{@version}",
      extras: ["README.md", "guides/sentence-transformers-parity.md", "guides/releasing.md", "CHANGELOG.md"],
      groups_for_modules: [
        Encoders: [Sting, Sting.Sparse, Sting.MultiVector],
        Retrieval: [Sting.Search, Sting.Mining],
        Utilities: [Sting.Similarity, Sting.Quantization]
      ]
    ]
  end
end