dspy-schema 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf1a5bda9480f0a5fd8e00f80949debb6bcd99e0ee014e767dc5ed7ac02440f1
-  data.tar.gz: a7c318b77fef71636125958148203960d9737897f1eed656471fbe03dd43c406
+  metadata.gz: 9f74029ea6216c0037bb06ceb6c7f59d97fb91b1eefa19eb1c7d44322b555394
+  data.tar.gz: '08d2fe0cd462d3dc454184a3996c015e8182244c1ad8731780f18e58fbdbe03d'
 SHA512:
-  metadata.gz: 8bf44b28876109783dc9570919f2a99f1a48a3b96823aec379f2a10b48ea84d281be226afb9a450a119a81f1721e9e37a990b5edf38b0aadc643f2cf94f49915
-  data.tar.gz: 3a34993c5c3252c63642a6892eed12e172d139dc834e53d04e7b79424e21f5f0d3ae245ef479dd6b013adec699f4d206daccf29864837db99231a853afc7f9c6
+  metadata.gz: ebf9688e45cdc399cd5be6fc72a6b923c8e4bc261d33b0e94fef6e77bd556af4cae3ade15698303088d023ea9207a8317de27e69a7c8803dd10aa1d9c56d797a
+  data.tar.gz: 746aaa4652c116c960f1be9bde5b6f9696c041ac3ac88622d1dcf23db4196b60ebd2686fdc58aebd8b62203ee6ce1cbe3a86946b31a22bf7252d8aac275481e4

data/README.md

@@ -4,6 +4,7 @@
 [![Total Downloads](https://img.shields.io/gem/dt/dspy)](https://rubygems.org/gems/dspy)
 [![Build Status](https://img.shields.io/github/actions/workflow/status/vicentereig/dspy.rb/ruby.yml?branch=main&label=build)](https://github.com/vicentereig/dspy.rb/actions/workflows/ruby.yml)
 [![Documentation](https://img.shields.io/badge/docs-vicentereig.github.io%2Fdspy.rb-blue)](https://vicentereig.github.io/dspy.rb/)
+[![Discord](https://img.shields.io/discord/1161519468141355160?label=discord&logo=discord&logoColor=white)](https://discord.gg/zWBhrMqn)
 
 > [!NOTE]
 > The core Prompt Engineering Framework is production-ready with
@@ -17,18 +18,13 @@
 
 **Build reliable LLM applications in idiomatic Ruby using composable, type-safe modules.**
 
-The Ruby framework for programming with large language models. DSPy.rb brings structured LLM programming to Ruby developers, programmatic Prompt Engineering and Context Engineering. 
-Instead of wrestling with prompt strings and parsing responses, you define typed signatures using idiomatic Ruby to compose and decompose AI Worklows and AI Agents.
+DSPy.rb is the Ruby-first surgical port of Stanford's [DSPy framework](https://github.com/stanfordnlp/dspy). It delivers structured LLM programming, prompt engineering, and context engineering in the language we love. Instead of wrestling with brittle prompt strings, you define typed signatures in idiomatic Ruby and compose workflows and agents that actually behave.
 
-**Prompts are the just Functions.** Traditional prompting is like writing code with string concatenation: it works until it doesn't. DSPy.rb brings you 
-the programming approach pioneered by [dspy.ai](https://dspy.ai/): instead of crafting fragile prompts, you define modular 
-signatures and let the framework handle the messy details.
+**Prompts are just functions.** Traditional prompting is like writing code with string concatenation: it works until it doesn't. DSPy.rb brings you the programming approach pioneered by [dspy.ai](https://dspy.ai/): define modular signatures and let the framework deal with the messy bits.
 
-DSPy.rb is an idiomatic Ruby surgical port of Stanford's [DSPy framework](https://github.com/stanfordnlp/dspy). While implementing 
-the core concepts of signatures, predictors, and the main optimization algorithms from the original Python library, DSPy.rb embraces Ruby 
-conventions and adds Ruby-specific innovations like Sorbet-base Typed system, ReAct loops, and production-ready integrations like non-blocking Open Telemetry Instrumentation.
+While we implement the same signatures, predictors, and optimization algorithms as the original library, DSPy.rb leans hard into Ruby conventions with Sorbet-based typing, ReAct loops, and production-ready integrations like non-blocking OpenTelemetry instrumentation.
 
-**What you get?** Ruby LLM applications that actually scale and don't break when you sneeze.
+**What you get?** Ruby LLM applications that scale and don't break when you sneeze.
 
 Check the [examples](examples/) and take them for a spin!
 
@@ -47,25 +43,12 @@ and
 bundle install
 ```
 
-### Optional Sibling Gems
-
-DSPy.rb ships multiple gems from this monorepo so you only install what you need. Add these alongside `dspy`:
-
-| Gem | Description |
-| --- | --- |
-| `dspy-schema` | Exposes `DSPy::TypeSystem::SorbetJsonSchema` so other projects (e.g., exa-ruby) can convert Sorbet types to JSON Schema without pulling the full DSPy stack. |
-| `dspy-code_act` | Think-Code-Observe agents that can synthesize and execute Ruby code safely. |
-| `dspy-datasets` | Dataset helpers plus Parquet/Polars tooling for richer evaluation corpora. |
-| `dspy-evals` | High-throughput evaluation harness with metrics, callbacks, and regression fixtures. |
-| `dspy-miprov2` | Bayesian optimization + Gaussian Process backend for the MIPROv2 teleprompter. |
-| `gepa` | GEPA optimizer core (Pareto engine, telemetry, reflective proposer) shared with `dspy-gepa`. |
-
-Set the matching `DSPY_WITH_*` environment variables (see `Gemfile`) to include or exclude each sibling gem when running Bundler locally.
 ### Your First Reliable Predictor
 
 ```ruby
+require 'dspy'
 
-# Configure DSPy globablly to use your fave LLM - you can override this on an instance levle. 
+# Configure DSPy globally to use your fave LLM (you can override per predictor).
 DSPy.configure do |c|
   c.lm = DSPy::LM.new('openai/gpt-4o-mini',
                       api_key: ENV['OPENAI_API_KEY'],
@@ -96,7 +79,7 @@ class Classify < DSPy::Signature
   end
 end
 
-# Wire it to the simplest prompting technique - a Predictn.
+# Wire it to the simplest prompting technique: a prediction loop.
 classify = DSPy::Predict.new(Classify)
 # it may raise an error if you mess the inputs or your LLM messes the outputs.
 result = classify.call(sentence: "This book was super fun to read!")
@@ -105,6 +88,31 @@ puts result.sentiment    # => #<Sentiment::Positive>
 puts result.confidence   # => 0.85
 ```
 
+Save this as `examples/first_predictor.rb` and run it with:
+
+```bash
+bundle exec ruby examples/first_predictor.rb
+```
+
+### Sibling Gems
+
+DSPy.rb ships multiple gems from this monorepo so you can opt into features with heavier dependency trees (e.g., datasets pull in Polars/Arrow, MIPROv2 requires `numo-*` BLAS bindings) only when you need them. Add these alongside `dspy`:
+
+| Gem | Description | Status |
+| --- | --- | --- |
+| `dspy-schema` | Exposes `DSPy::TypeSystem::SorbetJsonSchema` for downstream reuse. (Still required by the core `dspy` gem; extraction lets other projects depend on it directly.) | **Stable** (v1.0.0) |
+| `dspy-code_act` | Think-Code-Observe agents that synthesize and execute Ruby safely. (Add the gem or set `DSPY_WITH_CODE_ACT=1` before requiring `dspy/code_act`.) | **Stable** (v1.0.0) |
+| `dspy-datasets` | Dataset helpers plus Parquet/Polars tooling for richer evaluation corpora. (Toggle via `DSPY_WITH_DATASETS`.) | **Stable** (v1.0.0) |
+| `dspy-evals` | High-throughput evaluation harness with metrics, callbacks, and regression fixtures. (Toggle via `DSPY_WITH_EVALS`.) | **Stable** (v1.0.0) |
+| `dspy-miprov2` | Bayesian optimization + Gaussian Process backend for the MIPROv2 teleprompter. (Install or export `DSPY_WITH_MIPROV2=1` before requiring the teleprompter.) | **Stable** (v1.0.0) |
+| `dspy-gepa` | `DSPy::Teleprompt::GEPA`, reflection loops, experiment tracking, telemetry adapters. (Install or set `DSPY_WITH_GEPA=1`.) | **Stable** (v1.0.0) |
+| `gepa` | GEPA optimizer core (Pareto engine, telemetry, reflective proposer). | **Stable** (v1.0.0) |
+| `dspy-o11y` | Core observability APIs: `DSPy::Observability`, async span processor, observation types. (Install or set `DSPY_WITH_O11Y=1`.) | **Stable** (v1.0.0) |
+| `dspy-o11y-langfuse` | Auto-configures DSPy observability to stream spans to Langfuse via OTLP. (Install or set `DSPY_WITH_O11Y_LANGFUSE=1`.) | **Stable** (v1.0.0) |
+| `dspy-deep_search` | Production DeepSearch loop with Exa-backed search/read, token budgeting, and instrumentation (Issue #163). | **Stable** (v1.0.0) |
+| `dspy-deep_research` | Planner/QA orchestration atop DeepSearch plus the memory supervisor used by the CLI example. | **Stable** (v1.0.0) |
+
+Set the matching `DSPY_WITH_*` environment variables (see `Gemfile`) to include or exclude each sibling gem when running Bundler locally (for example `DSPY_WITH_GEPA=1` or `DSPY_WITH_O11Y_LANGFUSE=1`). Refer to `adr/013-dependency-tree.md` for the full dependency map and roadmap.
 ### Access to 200+ Models Across 5 Providers
 
 DSPy.rb provides unified access to major LLM providers with provider-specific optimizations:
@@ -145,7 +153,10 @@ end
 
 ## What You Get
 
-**Developer Experience:**
+**Developer Experience:** Official clients, multimodal coverage, and observability baked in.
+<details>
+<summary>Expand for everything included</summary>
+
 - LLM provider support using official Ruby clients:
   - [OpenAI Ruby](https://github.com/openai/openai-ruby) with vision model support
   - [Anthropic Ruby SDK](https://github.com/anthropics/anthropic-sdk-ruby) with multimodal capabilities
@@ -155,21 +166,33 @@ end
 - Runtime type checking with [Sorbet](https://sorbet.org/) including T::Enum and union types
 - Type-safe tool definitions for ReAct agents
 - Comprehensive instrumentation and observability
+</details>
+
+**Core Building Blocks:** Predictors, agents, and pipelines wired through type-safe signatures.
+<details>
+<summary>Expand for everything included</summary>
 
-**Core Building Blocks:**
 - **Signatures** - Define input/output schemas using Sorbet types with T::Enum and union type support
 - **Predict** - LLM completion with structured data extraction and multimodal support
 - **Chain of Thought** - Step-by-step reasoning for complex problems with automatic prompt optimization
 - **ReAct** - Tool-using agents with type-safe tool definitions and error recovery
 - **Module Composition** - Combine multiple LLM calls into production-ready workflows
+</details>
+
+**Optimization & Evaluation:** Treat prompt optimization like a real ML workflow.
+<details>
+<summary>Expand for everything included</summary>
 
-**Optimization & Evaluation:**
 - **Prompt Objects** - Manipulate prompts as first-class objects instead of strings
 - **Typed Examples** - Type-safe training data with automatic validation
 - **Evaluation Framework** - Advanced metrics beyond simple accuracy with error-resilient pipelines
 - **MIPROv2 Optimization** - Advanced Bayesian optimization with Gaussian Processes, multiple optimization strategies, auto-config presets, and storage persistence
+</details>
+
+**Production Features:** Hardened behaviors for teams shipping actual products.
+<details>
+<summary>Expand for everything included</summary>
 
-**Production Features:**
 - **Reliable JSON Extraction** - Native structured outputs for OpenAI and Gemini, Anthropic tool-based extraction, and automatic strategy selection with fallback
 - **Type-Safe Configuration** - Strategy enums with automatic provider optimization (Strict/Compatible modes)
 - **Smart Retry Logic** - Progressive fallback with exponential backoff for handling transient failures
@@ -177,10 +200,13 @@ end
 - **Performance Caching** - Schema and capability caching for faster repeated operations
 - **File-based Storage** - Optimization result persistence with versioning
 - **Structured Logging** - JSON and key=value formats with span tracking
+</details>
 
 ## Recent Achievements
 
-DSPy.rb has rapidly evolved from experimental to production-ready:
+DSPy.rb has gone from experimental to production-ready in three fast releases.
+<details>
+<summary>Expand for the full changelog highlights</summary>
 
 ### Foundation
 - ✅ **JSON Parsing Reliability** - Native OpenAI structured outputs with adaptive retry logic and schema-aware fallbacks
@@ -196,8 +222,11 @@ DSPy.rb has rapidly evolved from experimental to production-ready:
 - ✅ **Optimizer Utilities Parity (v0.29.0)** - Bootstrap strategies, dataset summaries, and Layer 3 utilities unlock multi-predictor programs on Ruby
 - ✅ **Observability Hardening (v0.29.0)** - OTLP exporter runs on a single-thread executor preventing frozen SSL contexts without blocking spans
 - ✅ **Documentation Refresh (v0.29.x)** - New GEPA guide plus ADE optimization docs covering presets, stratified splits, and error-handling defaults
+</details>
 
-**Current Focus Areas:**
+**Current Focus Areas:** Closing the loop on production patterns and community adoption ahead of v1.0.
+<details>
+<summary>Expand for the roadmap</summary>
 
 ### Production Readiness
 - 🚧 **Production Patterns** - Real-world usage validation and performance optimization
@@ -207,10 +236,9 @@ DSPy.rb has rapidly evolved from experimental to production-ready:
 - 🚧 **Community Examples** - Real-world applications and case studies
 - 🚧 **Contributor Experience** - Making it easier to contribute and extend
 - 🚧 **Performance Benchmarks** - Comparative analysis vs other frameworks
+</details>
 
-**v1.0 Philosophy:**
-v1.0 will be released after extensive production battle-testing, not after checking off features.
-The API is already stable - v1.0 represents confidence in production reliability backed by real-world validation.
+**v1.0 Philosophy:** v1.0 lands after battle-testing, not checkbox bingo. The API is already stable; the milestone marks production confidence.
 
 
 ## Documentation

data/lib/dspy/schema/version.rb

@@ -2,6 +2,6 @@
 
 module DSPy
   module Schema
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dspy-schema
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Vicente Reig Rincón de Arellano
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-10-25 00:00:00.000000000 Z
+date: 2025-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -41,6 +42,7 @@ licenses:
 - MIT
 metadata:
   github_repo: git@github.com:vicentereig/dspy.rb
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -48,14 +50,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Sorbet to JSON Schema conversion utilities reused by DSPy.rb.
 test_files: []