red-candle 1.0.0.pre.1 → 1.0.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34ca4771af8508ace5ee8df5d5111a407c79fea307f9fbc2b72d9e46d6dd2099
-  data.tar.gz: 39a316c2990f8766257e07c5ae8803ba852aebc5c93b14349548b1da82b6ae4a
+  metadata.gz: 375ffec5c2293170bdb0e78ffe2584c8a963968d3226b601d12ddcc040c256ec
+  data.tar.gz: ea2490c59eca2480728afb7169fc3a24f4270e63491648c1d09fd111707dcb7e
 SHA512:
-  metadata.gz: 51fcc58936f25818485bacd5dfc86911ca1ecbc0a8b87f6fdcf2d015a91faccd6aeb889df33a931eae6d864984254ab4a81ab7050fb00caf14d090820cf4d86b
-  data.tar.gz: f6e58cc4e723c12e3d290fcb45b1cab5923594bfd011be223ec327c65c7c91cb7d37f9330ed82eadd4b7eb3085ef0ba9b874a6b98c15221b21c60cd01de11418
+  metadata.gz: 9011c72cbe2a065917f26774862bb1f82489e6d5354376cb616df7cea18646ca60ccd5e68282f39b23f89eead196ab41ce70cdaaca224f97aef61914559f653f
+  data.tar.gz: 4a48101bdcffeecd1bc687dacc7eee7dc42ddbb417b05cce57b97abad83cefe90d965be5c0a8256b8f5c9ba90d80f1159c5392097558acf93a3095913a68a2ad

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "minitest"
+gem "rake"
+gem "rake-compiler"
+
+gem "yard", require: false
+gem "yard-rustdoc", require: false
+
+gem "redcarpet", "~> 3.6"

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 kojix2
+Copyright (c) 2024 Christopher Petersen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rake/extensiontask"
+
+ENV['CANDLE_TEST_SKIP_LLM'] = 'true'
+
+task default: :test
+Rake::TestTask.new do |t|
+  t.deps << :compile
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+spec = Bundler.load_gemspec("candle.gemspec")
+Rake::ExtensionTask.new("candle", spec) do |c|
+  c.lib_dir = "lib/candle"
+  c.cross_compile = true
+  c.cross_platform = %w[
+    aarch64-linux
+    arm64-darwin
+    x64-mingw-ucrt
+    x64-mingw32
+    x86_64-darwin
+    x86_64-linux
+    x86_64-linux-musl
+  ]
+end
+
+desc "Run device compatibility tests"
+Rake::TestTask.new("test:device") do |t|
+  t.deps << :compile
+  t.libs << "test"
+  t.test_files = FileList["test/device_compatibility_test.rb"]
+  t.verbose = true
+end
+
+desc "Run benchmark tests"
+Rake::TestTask.new("test:benchmark") do |t|
+  ENV['CANDLE_RUN_BENCHMARKS'] = 'true'
+  t.deps << :compile
+  t.libs << "test"
+  t.test_files = FileList["test/benchmarks/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc "Run all tests including benchmarks"
+task "test:all" => [:test, "test:benchmark"]
+
+desc "Run tests on specific devices"
+namespace :test do
+  %w[cpu metal cuda].each do |device|
+    desc "Run tests on #{device.upcase} only"
+    task "device:#{device}" => :compile do
+      ENV['CANDLE_TEST_DEVICES'] = device
+      Rake::Task["test:device"].invoke
+    end
+  end
+end
+
+desc "Run benchmarks with device tests"
+task "test:device:benchmark" => :compile do
+  ENV['CANDLE_RUN_BENCHMARKS'] = 'true'
+  ENV['CANDLE_TEST_VERBOSE'] = 'true'
+  Rake::Task["test:device"].invoke
+  Rake::Task["test:benchmark"].invoke
+end
+
+namespace :doc do
+  task default: %i[rustdoc yard]
+
+  desc "Generate YARD documentation"
+  task :yard do
+    sh <<~CMD
+      yard doc \
+        --plugin rustdoc -- lib tmp/doc/candle.json
+    CMD
+  end
+
+  desc "Generate Rust documentation as JSON"
+  task :rustdoc do
+    sh <<~CMD
+      cargo +nightly rustdoc \
+        --target-dir tmp/doc/target \
+        -p candle \
+        -- -Zunstable-options --output-format json \
+        --document-private-items
+    CMD
+
+    cp "tmp/doc/target/doc/candle.json", "tmp/doc/candle.json"
+  end
+end
+
+task doc: "doc:default"

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "candle"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+# Check if Rust is installed
+if ! command -v cargo &> /dev/null
+then
+    echo "Rust is not installed. Please install Rust: https://www.rust-lang.org/tools/install"
+    exit 1
+fi
+
+# Install Ruby dependencies
+bundle install
+
+# Build Rust extension
+bundle exec rake compile

data/ext/candle/rustfmt.toml

@@ -0,0 +1,63 @@
+max_width = 100
+hard_tabs = false
+tab_spaces = 4
+newline_style = "Auto"
+use_small_heuristics = "Default"
+indent_style = "Block"
+wrap_comments = false
+format_code_in_doc_comments = false
+comment_width = 80
+normalize_comments = false
+normalize_doc_attributes = false
+format_strings = false
+format_macro_matchers = false
+format_macro_bodies = true
+empty_item_single_line = true
+struct_lit_single_line = true
+fn_single_line = false
+where_single_line = false
+imports_indent = "Block"
+imports_layout = "Mixed"
+imports_granularity="Crate"
+reorder_imports = true
+reorder_modules = true
+reorder_impl_items = false
+type_punctuation_density = "Wide"
+space_before_colon = false
+space_after_colon = true
+spaces_around_ranges = false
+binop_separator = "Front"
+remove_nested_parens = true
+combine_control_expr = true
+overflow_delimited_expr = false
+struct_field_align_threshold = 0
+enum_discrim_align_threshold = 0
+match_arm_blocks = true
+force_multiline_blocks = false
+fn_params_layout = "Tall"
+brace_style = "SameLineWhere"
+control_brace_style = "AlwaysSameLine"
+trailing_semicolon = true
+trailing_comma = "Vertical"
+match_block_trailing_comma = false
+blank_lines_upper_bound = 1
+blank_lines_lower_bound = 0
+edition = "2021"
+version = "One"
+inline_attribute_width = 0
+merge_derives = true
+use_try_shorthand = false
+use_field_init_shorthand = false
+force_explicit_abi = true
+condense_wildcard_suffixes = false
+color = "Auto"
+#required_version = "1.4.12"
+unstable_features = false
+disable_all_formatting = false
+skip_children = false
+hide_parse_errors = false
+error_on_line_overflow = false
+error_on_unformatted = false
+ignore = []
+emit_mode = "Files"
+make_backup = false

data/ext/candle/src/lib.rs

@@ -1,7 +1,7 @@
-use magnus::{function, method, prelude::*, Ruby};
+use magnus::{function, prelude::*, Ruby};
 
 use crate::ruby::candle_utils;
-use crate::ruby::{DType, Device, QTensor, Result as RbResult, Tensor};
+use crate::ruby::Result as RbResult;
 
 pub mod llm;
 pub mod reranker;
@@ -42,101 +42,11 @@ fn init(ruby: &Ruby) -> RbResult<()> {
     ruby::init_embedding_model(rb_candle)?;
     ruby::init_llm(rb_candle)?;
     reranker::init(rb_candle)?;
+    ruby::dtype::init(rb_candle)?;
+    ruby::qtensor::init(rb_candle)?;
+    ruby::device::init(rb_candle)?;
+    ruby::tensor::init(rb_candle)?;
     candle_utils(rb_candle)?;
-    let rb_tensor = rb_candle.define_class("Tensor", Ruby::class_object(ruby))?;
-    rb_tensor.define_singleton_method("new", function!(Tensor::new, 3))?;
-    // rb_tensor.define_singleton_method("cat", function!(Tensor::cat, 2))?;
-    // rb_tensor.define_singleton_method("stack", function!(Tensor::stack, 2))?;
-    rb_tensor.define_singleton_method("rand", function!(Tensor::rand, 2))?;
-    rb_tensor.define_singleton_method("randn", function!(Tensor::randn, 2))?;
-    rb_tensor.define_singleton_method("ones", function!(Tensor::ones, 2))?;
-    rb_tensor.define_singleton_method("zeros", function!(Tensor::zeros, 2))?;
-    rb_tensor.define_method("values", method!(Tensor::values, 0))?;
-    rb_tensor.define_method("values_f32", method!(Tensor::values_f32, 0))?;
-    rb_tensor.define_method("item", method!(Tensor::item, 0))?;
-    rb_tensor.define_method("shape", method!(Tensor::shape, 0))?;
-    rb_tensor.define_method("stride", method!(Tensor::stride, 0))?;
-    rb_tensor.define_method("dtype", method!(Tensor::dtype, 0))?;
-    rb_tensor.define_method("device", method!(Tensor::device, 0))?;
-    rb_tensor.define_method("rank", method!(Tensor::rank, 0))?;
-    rb_tensor.define_method("elem_count", method!(Tensor::elem_count, 0))?;
-    rb_tensor.define_method("sin", method!(Tensor::sin, 0))?;
-    rb_tensor.define_method("cos", method!(Tensor::cos, 0))?;
-    rb_tensor.define_method("log", method!(Tensor::log, 0))?;
-    rb_tensor.define_method("sqr", method!(Tensor::sqr, 0))?;
-    rb_tensor.define_method("mean", method!(Tensor::mean, 1))?;
-    rb_tensor.define_method("sum", method!(Tensor::sum, 1))?;
-    rb_tensor.define_method("sqrt", method!(Tensor::sqrt, 0))?;
-    rb_tensor.define_method("/", method!(Tensor::__truediv__, 1))?; // Accepts Tensor, Float, or Integer
-    rb_tensor.define_method("recip", method!(Tensor::recip, 0))?;
-    rb_tensor.define_method("exp", method!(Tensor::exp, 0))?;
-    rb_tensor.define_method("powf", method!(Tensor::powf, 1))?;
-    rb_tensor.define_method("index_select", method!(Tensor::index_select, 2))?;
-    rb_tensor.define_method("matmul", method!(Tensor::matmul, 1))?;
-    rb_tensor.define_method("broadcast_add", method!(Tensor::broadcast_add, 1))?;
-    rb_tensor.define_method("broadcast_sub", method!(Tensor::broadcast_sub, 1))?;
-    rb_tensor.define_method("broadcast_mul", method!(Tensor::broadcast_mul, 1))?;
-    rb_tensor.define_method("broadcast_div", method!(Tensor::broadcast_div, 1))?;
-    rb_tensor.define_method("where_cond", method!(Tensor::where_cond, 2))?;
-    rb_tensor.define_method("+", method!(Tensor::__add__, 1))?;
-    rb_tensor.define_method("*", method!(Tensor::__mul__, 1))?;
-    rb_tensor.define_method("-", method!(Tensor::__sub__, 1))?;
-    rb_tensor.define_method("reshape", method!(Tensor::reshape, 1))?;
-    rb_tensor.define_method("broadcast_as", method!(Tensor::broadcast_as, 1))?;
-    rb_tensor.define_method("broadcast_left", method!(Tensor::broadcast_left, 1))?;
-    rb_tensor.define_method("squeeze", method!(Tensor::squeeze, 1))?;
-    rb_tensor.define_method("unsqueeze", method!(Tensor::unsqueeze, 1))?;
-    rb_tensor.define_method("get", method!(Tensor::get, 1))?;
-    rb_tensor.define_method("[]", method!(Tensor::get, 1))?;
-    rb_tensor.define_method("transpose", method!(Tensor::transpose, 2))?;
-    rb_tensor.define_method("narrow", method!(Tensor::narrow, 3))?;
-    rb_tensor.define_method("argmax_keepdim", method!(Tensor::argmax_keepdim, 1))?;
-    rb_tensor.define_method("argmin_keepdim", method!(Tensor::argmin_keepdim, 1))?;
-    rb_tensor.define_method("max_keepdim", method!(Tensor::max_keepdim, 1))?;
-    rb_tensor.define_method("min_keepdim", method!(Tensor::min_keepdim, 1))?;
-    // rb_tensor.define_method("eq", method!(Tensor::eq, 1))?;
-    // rb_tensor.define_method("ne", method!(Tensor::ne, 1))?;
-    // rb_tensor.define_method("lt", method!(Tensor::lt, 1))?;
-    // rb_tensor.define_method("gt", method!(Tensor::gt, 1))?;
-    // rb_tensor.define_method("ge", method!(Tensor::ge, 1))?;
-    // rb_tensor.define_method("le", method!(Tensor::le, 1))?;
-    rb_tensor.define_method("sum_all", method!(Tensor::sum_all, 0))?;
-    rb_tensor.define_method("mean_all", method!(Tensor::mean_all, 0))?;
-    rb_tensor.define_method("flatten_from", method!(Tensor::flatten_from, 1))?;
-    rb_tensor.define_method("flatten_to", method!(Tensor::flatten_to, 1))?;
-    rb_tensor.define_method("flatten_all", method!(Tensor::flatten_all, 0))?;
-    rb_tensor.define_method("t", method!(Tensor::t, 0))?;
-    rb_tensor.define_method("contiguous", method!(Tensor::contiguous, 0))?;
-    rb_tensor.define_method("is_contiguous", method!(Tensor::is_contiguous, 0))?;
-    rb_tensor.define_method(
-        "is_fortran_contiguous",
-        method!(Tensor::is_fortran_contiguous, 0),
-    )?;
-    rb_tensor.define_method("detach", method!(Tensor::detach, 0))?;
-    rb_tensor.define_method("copy", method!(Tensor::copy, 0))?;
-    rb_tensor.define_method("to_dtype", method!(Tensor::to_dtype, 1))?;
-    rb_tensor.define_method("to_device", method!(Tensor::to_device, 1))?;
-    rb_tensor.define_method("to_s", method!(Tensor::__str__, 0))?;
-    rb_tensor.define_method("inspect", method!(Tensor::__repr__, 0))?;
-
-    let rb_dtype = rb_candle.define_class("DType", Ruby::class_object(ruby))?;
-    rb_dtype.define_method("to_s", method!(DType::__str__, 0))?;
-    rb_dtype.define_method("inspect", method!(DType::__repr__, 0))?;
-
-    let rb_device = rb_candle.define_class("Device", Ruby::class_object(ruby))?;
-    rb_device.define_singleton_method("cpu", function!(Device::cpu, 0))?;
-    rb_device.define_singleton_method("cuda", function!(Device::cuda, 0))?;
-    rb_device.define_singleton_method("metal", function!(Device::metal, 0))?;
-    rb_device.define_singleton_method("available_devices", function!(ruby::device::available_devices, 0))?;
-    rb_device.define_singleton_method("default", function!(ruby::device::default_device, 0))?;
-    rb_device.define_method("to_s", method!(Device::__str__, 0))?;
-    rb_device.define_method("inspect", method!(Device::__repr__, 0))?;
-
-    let rb_qtensor = rb_candle.define_class("QTensor", Ruby::class_object(ruby))?;
-    rb_qtensor.define_method("ggml_dtype", method!(QTensor::ggml_dtype, 0))?;
-    rb_qtensor.define_method("rank", method!(QTensor::rank, 0))?;
-    rb_qtensor.define_method("shape", method!(QTensor::shape, 0))?;
-    rb_qtensor.define_method("dequantize", method!(QTensor::dequantize, 0))?;
 
     Ok(())
 }

data/ext/candle/src/llm/generation_config.rs

@@ -0,0 +1,49 @@
+use std::time::{SystemTime, UNIX_EPOCH};
+
+/// Configuration for text generation
+#[derive(Debug, Clone)]
+pub struct GenerationConfig {
+    /// The maximum number of tokens to generate
+    pub max_length: usize,
+    /// The temperature for sampling
+    pub temperature: f64,
+    /// The top-p value for nucleus sampling
+    pub top_p: Option<f64>,
+    /// The top-k value for top-k sampling
+    pub top_k: Option<usize>,
+    /// The repetition penalty
+    pub repetition_penalty: f32,
+    /// The repetition penalty range
+    pub repetition_penalty_last_n: usize,
+    /// Random seed for sampling
+    pub seed: u64,
+    /// Stop sequences
+    pub stop_sequences: Vec<String>,
+    /// Whether to return the prompt in the output
+    pub include_prompt: bool,
+}
+
+/// Generate a random seed based on current time
+fn random_seed() -> u64 {
+    SystemTime::now()
+        .duration_since(UNIX_EPOCH)
+        .map(|d| d.as_nanos() as u64)
+        .unwrap_or(42)
+}
+
+impl Default for GenerationConfig {
+    fn default() -> Self {
+        Self {
+            max_length: 512,
+            temperature: 0.7,
+            top_p: None,
+            top_k: None,
+            repetition_penalty: 1.1,
+            repetition_penalty_last_n: 64,
+            seed: random_seed(),
+            stop_sequences: vec![],
+            include_prompt: false,
+        }
+    }
+}
+