lancelot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e84754226b79241530dd10c90c67d97589e79a217ccbe636d836fa42cdcd450
+  data.tar.gz: fcbbe98ba47a8276d1e1f95a4cc34a84232f7886eef33d955d335eed36248b65
+SHA512:
+  metadata.gz: 5a4e28401f3167189d55cd9d543fa1a4d5ecff5f99423aecf371b6d9dbf0126c106a2b52bd67352a364d98c9edce66d4d3e3beea06bedfdc99bf92c065040fec
+  data.tar.gz: 939bdfd0e3ffaf0b21ccf88562bf4dac73656c5dc3fe511ed3b0696646e47d4a67a25b1d3d4b0c0d8e586a74514fdddb252b5e27616f90890f1a0abc8508b68b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Initial gem structure with Magnus/Rust integration
+- Basic Dataset class with create/open functionality
+- Core data storage with Lance integration
+- Schema definition support for string and float32 types
+- Document addition with add_documents and << methods
+- Row counting functionality
+- Comprehensive test suite for Phase 2 features
+- Project setup and configuration

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Chris 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/README.md

@@ -0,0 +1,152 @@
+# Lancelot
+
+Ruby bindings for [Lance](https://github.com/lancedb/lance), a modern columnar data format for ML. Lancelot provides a Ruby-native interface to Lance, enabling efficient storage and search of multimodal data including text, vectors, and more.
+
+## Features
+
+### Implemented
+- **Dataset Creation**: Create Lance datasets with schemas
+- **Data Storage**: Add documents to datasets  
+- **Document Retrieval**: Read documents from datasets with enumerable support
+- **Vector Search**: Create vector indices and perform similarity search
+- **Schema Support**: Define schemas with string, float32, and vector types
+- **Row Counting**: Get the number of rows in a dataset
+
+### Planned
+
+- **Full-Text Search**: Built-in full-text search capabilities  
+- **Hybrid Search**: Combine text and vector search with RRF and other fusion methods
+- **Multimodal Support**: Store and search across different data types beyond text and vectors
+- **Schema Evolution**: Add new columns to existing datasets without rewriting data
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add lancelot
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install lancelot
+```
+
+## Usage
+
+```ruby
+require 'lancelot'
+
+# Create a dataset with a schema including vectors
+dataset = Lancelot::Dataset.create("path/to/dataset", schema: {
+  text: :string,
+  score: :float32,
+  embedding: { type: "vector", dimension: 128 }
+})
+
+# Add documents with embeddings
+dataset.add_documents([
+  { text: "Ruby is a dynamic programming language", score: 0.95, embedding: [0.1, 0.2, ...] },
+  { text: "Python is great for data science", score: 0.88, embedding: [0.2, 0.3, ...] }
+])
+
+# Or use the << operator
+dataset << { text: "JavaScript runs everywhere", score: 0.92, embedding: [0.3, 0.4, ...] }
+
+# Open an existing dataset
+dataset = Lancelot::Dataset.open("path/to/dataset")
+
+# Get the count
+puts dataset.count  # => 3
+
+# Get the schema
+puts dataset.schema  # => { text: "string", score: "float32" }
+
+# Retrieve documents
+dataset.all           # => Returns all documents
+dataset.first         # => Returns first document
+dataset.first(2)      # => Returns first 2 documents
+
+# Enumerable support
+dataset.each { |doc| puts doc[:text] }
+dataset.map { |doc| doc[:score] }
+dataset.select { |doc| doc[:score] > 0.9 }
+
+# Vector search
+dataset.create_vector_index("embedding")  # Create vector index
+results = dataset.vector_search([0.15, 0.25, ...], column: "embedding", limit: 5)  # Find 5 nearest neighbors
+
+# Or use the nearest_neighbors alias
+similar = dataset.nearest_neighbors([0.1, 0.2, ...], k: 10, column: "embedding")
+
+# Full-text search with inverted indices
+# First create text indices on the columns you want to search
+dataset.create_text_index("title")
+dataset.create_text_index("content")
+dataset.create_text_index("tags")
+
+# Single column search
+results = dataset.text_search("ruby programming", column: "content", limit: 10)
+
+# Multi-column search
+results = dataset.text_search("machine learning", columns: ["title", "content"], limit: 10)
+
+# SQL-like filtering (uses Lance's SQL engine, not full-text indices)
+results = dataset.where("score > 0.9")
+results = dataset.where("category = 'tutorial' AND year >= 2023", limit: 5)
+```
+
+### Full-Text Search
+
+Lancelot supports Lance's full-text search capabilities with inverted indices:
+
+```ruby
+# Create indices before searching
+dataset.create_text_index("title")
+dataset.create_text_index("content")
+
+# Search a single column
+results = dataset.text_search("ruby", column: "title")
+
+# Search multiple columns (returns union of results)
+results = dataset.text_search("programming", columns: ["title", "content", "tags"])
+
+# The underlying Lance engine provides:
+# - BM25 scoring for relevance ranking
+# - Tokenization with language support
+# - Case-insensitive search
+# - Multi-word queries
+```
+
+**Note**: Full-text search requires creating inverted indices first. For simple pattern matching without indices, use SQL-like filtering with `where`.
+
+**Current Limitations:**
+- Schema must be defined when creating a dataset
+- Schema evolution is not yet implemented (Lance supports it, but our bindings don't expose it yet)
+- Hybrid search (RRF) is not yet implemented
+- Supported field types: string, float32, float64, int32, int64, boolean, and fixed-size vectors
+
+**Note on Lance's Schema Flexibility:**
+Lance itself supports schema evolution - you can add new columns without rewriting data. However, our current Ruby bindings have simplified this and require an upfront schema. This will be improved in future releases to expose Lance's full flexibility.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To compile the Rust extension:
+```bash
+bundle exec rake compile
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cpetersen/lancelot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/cpetersen/lancelot/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Lancelot project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cpetersen/lancelot/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+require "rake/extensiontask"
+
+task build: :compile
+
+GEMSPEC = Gem::Specification.load("lancelot.gemspec")
+
+Rake::ExtensionTask.new("lancelot", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/lancelot"
+end
+
+task default: %i[clobber compile spec standard]

data/examples/basic_usage.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lancelot"
+require "tmpdir"
+
+# Create a temporary directory for our dataset
+Dir.mktmpdir do |dir|
+  dataset_path = File.join(dir, "my_dataset")
+  
+  puts "Creating dataset at: #{dataset_path}"
+  
+  # Create a dataset with a schema
+  dataset = Lancelot::Dataset.create(dataset_path, schema: {
+    text: :string,
+    score: :float32
+  })
+  
+  # Add documents
+  dataset.add_documents([
+    { text: "Ruby is a dynamic programming language", score: 0.95 },
+    { text: "Python is great for data science", score: 0.88 }
+  ])
+  
+  # Or use the << operator
+  dataset << { text: "JavaScript runs everywhere", score: 0.92 }
+  
+  # Get the count
+  puts "Document count: #{dataset.count}"
+  
+  # Get the schema
+  puts "Schema: #{dataset.schema.inspect}"
+  
+  # Retrieve documents
+  puts "\nRetrieving documents:"
+  puts "First document: #{dataset.first.inspect}"
+  puts "First 2 documents: #{dataset.first(2).map { |d| d[:text] }.join(', ')}"
+  
+  # Use Enumerable methods
+  puts "\nUsing Enumerable methods:"
+  texts = dataset.map { |doc| doc[:text] }
+  puts "All texts: #{texts.join(', ')}"
+  
+  high_scores = dataset.select { |doc| doc[:score] > 0.9 }
+  puts "High scoring documents: #{high_scores.map { |d| d[:text] }.join(', ')}"
+  
+  # Open an existing dataset
+  dataset2 = Lancelot::Dataset.open(dataset_path)
+  puts "\nOpened dataset has #{dataset2.count} documents"
+end
+
+puts "Done!"

data/examples/full_text_search.rb

@@ -0,0 +1,146 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'lancelot'
+require 'tmpdir'
+
+Dir.mktmpdir do |dir|
+  dataset_path = File.join(dir, "articles_dataset")
+  
+  puts "Creating dataset with article data..."
+  
+  # Create a dataset with multiple text fields
+  dataset = Lancelot::Dataset.create(dataset_path, schema: {
+    title: :string,
+    content: :string,
+    category: :string,
+    author: :string,
+    year: :int64,
+    tags: :string
+  })
+  
+  # Sample articles
+  articles = [
+    { 
+      title: "Getting Started with Ruby on Rails", 
+      content: "Ruby on Rails is a powerful web framework that makes building applications fast and enjoyable. It follows the MVC pattern and emphasizes convention over configuration.",
+      category: "web development",
+      author: "Alice Johnson",
+      year: 2024,
+      tags: "ruby rails web mvc framework"
+    },
+    { 
+      title: "Advanced Ruby Metaprogramming Techniques", 
+      content: "Ruby's metaprogramming capabilities allow you to write code that writes code. Learn about method_missing, define_method, and dynamic class creation.",
+      category: "programming",
+      author: "Bob Smith",
+      year: 2024,
+      tags: "ruby metaprogramming advanced dynamic"
+    },
+    { 
+      title: "Building RESTful APIs with Rails", 
+      content: "Learn how to build robust RESTful APIs using Ruby on Rails. We'll cover routing, controllers, serialization, and authentication.",
+      category: "web development",
+      author: "Alice Johnson",
+      year: 2023,
+      tags: "ruby rails api rest web services"
+    },
+    { 
+      title: "Python vs Ruby: A Comprehensive Comparison", 
+      content: "Both Python and Ruby are dynamic, interpreted languages. This article compares their syntax, performance, ecosystem, and use cases.",
+      category: "programming",
+      author: "Charlie Davis",
+      year: 2024,
+      tags: "python ruby comparison languages programming"
+    },
+    { 
+      title: "Machine Learning with Python", 
+      content: "Python has become the de facto language for machine learning. Explore popular libraries like scikit-learn, TensorFlow, and PyTorch.",
+      category: "data science",
+      author: "David Lee",
+      year: 2024,
+      tags: "python machine learning ml ai data science"
+    },
+    { 
+      title: "Rust for Systems Programming", 
+      content: "Rust provides memory safety without garbage collection. Learn how Rust is revolutionizing systems programming with its ownership model.",
+      category: "systems",
+      author: "Eve Wilson",
+      year: 2023,
+      tags: "rust systems programming memory safety performance"
+    }
+  ]
+  
+  # Add articles
+  dataset.add_documents(articles)
+  puts "Added #{dataset.count} articles\n\n"
+  
+  # Create text indices on multiple columns
+  puts "Creating text indices..."
+  dataset.create_text_index("title")
+  dataset.create_text_index("content")
+  dataset.create_text_index("tags")
+  puts "Text indices created\n\n"
+  
+  # Test 1: Single column full-text search
+  puts "=== Single Column Full-Text Search ==="
+  
+  puts "\nSearching for 'ruby' in content:"
+  results = dataset.text_search("ruby", column: "content", limit: 5)
+  results.each do |doc|
+    puts "  - #{doc[:title]}"
+    puts "    #{doc[:content][0..80]}..."
+  end
+  
+  # Test 2: Search in title
+  puts "\n\nSearching for 'python' in title:"
+  results = dataset.text_search("python", column: "title", limit: 5)
+  results.each do |doc|
+    puts "  - #{doc[:title]} (#{doc[:year]})"
+  end
+  
+  # Test 3: Search in tags
+  puts "\n\nSearching for 'programming' in tags:"
+  results = dataset.text_search("programming", column: "tags", limit: 5)
+  results.each do |doc|
+    puts "  - #{doc[:title]}"
+    puts "    Tags: #{doc[:tags]}"
+  end
+  
+  # Test 4: Multi-column search
+  puts "\n\n=== Multi-Column Full-Text Search ==="
+  
+  puts "\nSearching for 'ruby' across title and content:"
+  results = dataset.text_search("ruby", columns: ["title", "content"], limit: 10)
+  results.each do |doc|
+    puts "  - #{doc[:title]} by #{doc[:author]}"
+  end
+  
+  # Test 5: Complex multi-word queries
+  puts "\n\nSearching for 'machine learning' across all text fields:"
+  results = dataset.text_search("machine learning", columns: ["title", "content", "tags"], limit: 5)
+  results.each do |doc|
+    puts "  - #{doc[:title]}"
+    puts "    Category: #{doc[:category]}"
+  end
+  
+  # Test 6: Combining with SQL filters
+  puts "\n\n=== Combining Full-Text Search with Filters ==="
+  
+  # First do a text search, then filter by year
+  puts "\nArticles about 'programming' from 2024:"
+  all_results = dataset.text_search("programming", column: "content", limit: 20)
+  filtered = all_results.select { |doc| doc[:year] == 2024 }
+  filtered.each do |doc|
+    puts "  - #{doc[:title]} (#{doc[:year]})"
+  end
+  
+  # Or use SQL filter for category
+  puts "\n\nWeb development articles:"
+  results = dataset.where("category = 'web development'")
+  results.each do |doc|
+    puts "  - #{doc[:title]}"
+  end
+end
+
+puts "\nDone!"

data/examples/red_candle_integration.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'lancelot'
+require 'red-candle'
+require 'tmpdir'
+
+Dir.mktmpdir do |dir|
+  dataset_path = File.join(dir, "embeddings.lance")
+  
+  puts "Creating dataset at: #{dataset_path}"
+  
+  # Create a dataset with text and embedding columns
+  dataset = Lancelot::Dataset.create(dataset_path, schema: {
+    text: :string,
+    embedding: { type: "vector", dimension: 768 }
+  })
+  
+  # Initialize the embedding model
+  embedding_model = Candle::EmbeddingModel.new
+  puts "Using embedding model: jinaai/jina-embeddings-v2-base-en"
+  
+  # Sample documents
+  documents = [
+    "Ruby is a dynamic, object-oriented programming language",
+    "Python is great for data science and machine learning",
+    "JavaScript runs in browsers and on servers with Node.js",
+    "Rust provides memory safety without garbage collection",
+    "Go makes concurrent programming easy with goroutines",
+    "Java is widely used in enterprise applications",
+    "C++ offers high performance and low-level control",
+    "TypeScript adds static typing to JavaScript",
+  ]
+  
+  # Add documents with embeddings
+  puts "\nAdding documents..."
+  documents.each do |text|
+    embedding = embedding_model.embedding(text)
+    
+    # Convert tensor to array (remove batch dimension)
+    embedding_array = embedding.squeeze(0).to_a
+    
+    dataset.add_documents([
+      { text: text, embedding: embedding_array }
+    ])
+    
+    puts "  Added: #{text[0..50]}..."
+  end
+  
+  puts "\nTotal documents: #{dataset.count}"
+  
+  # Create vector index
+  puts "\nCreating vector index..."
+  dataset.create_vector_index("embedding")
+  
+  # Perform vector search
+  query = "Which languages are good for systems programming?"
+  puts "\nSearching for: '#{query}'"
+  
+  # Generate embedding for query
+  query_embedding = embedding_model.embedding(query)
+  query_array = query_embedding.squeeze(0).to_a
+  
+  # Search for similar documents
+  results = dataset.vector_search(query_array, column: "embedding", limit: 3)
+  
+  puts "\nTop 3 most similar documents:"
+  results.each_with_index do |doc, i|
+    puts "#{i + 1}. #{doc[:text]}"
+  end
+  
+  # Another search
+  query2 = "dynamic typing and interpreted languages"
+  puts "\n\nSearching for: '#{query2}'"
+  
+  query_embedding2 = embedding_model.embedding(query2)
+  query_array2 = query_embedding2.squeeze(0).to_a
+  
+  similar = dataset.nearest_neighbors(query_array2, k: 3, column: "embedding")
+  
+  puts "\nTop 3 nearest neighbors:"
+  similar.each_with_index do |doc, i|
+    puts "#{i + 1}. #{doc[:text]}"
+  end
+end
+
+puts "\nDone!"