boxcars 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5ecef1207a69d835d18b96f8d3412c58c84faaf15c5f783c5a8722aafd88ba0
-  data.tar.gz: ac308f23b0b98a733ac24f364caac8e724d3c319e550e35d1b7eef2b8477fd03
+  metadata.gz: 1d5ae0de1aba4038723912365d6ac1d50da0e34a40aad508130ecc86e71f91de
+  data.tar.gz: e0430621516358a59b7eeaadfa44fe78eed0b3ef92d929c264435d0946dbce5e
 SHA512:
-  metadata.gz: 132bddb5d37af596a9da1e91902fb64d3df55e626806ab56b76d958d7a83ef65625a3ed2fa974dcb24a2b2cba31b858d7830b4b02fe07d27cf31f264e8ae78c8
-  data.tar.gz: 64a536a7d5e8c3f93e186bfab8d638d27c4077f6f67851461d6d01fe6d9d166e7b648d7d83ba205fbd8d45e60bd3312202632a12fe1e378341d95f3b4571c54c
+  metadata.gz: a054ad6b3b3caef1c6bb39fbd9a667779c4dc638800e905b717285b8f5dde4a578e3325373176b099af9f4f7d07b6f7803f87fe67c4f771bfce8894ef209188e
+  data.tar.gz: f3a3020bd0c393c25cd430b8702e26a7a39b87127372787c416042da63c6fb90826773ca81a456ba67a1add908790620757d8b9aab4db32269e3391d576c5ea5

data/CHANGELOG.md

@@ -1,15 +1,36 @@
-## [0.1.2] - 2023-02-16
+# Changelog
 
-Changes
-- cleaned up and added more yard docs
-- required open ai gem and logger inside gem to simplify use
-- updated README with examples
+## [Unreleased](https://github.com/BoxcarsAI/boxcars/tree/HEAD)
 
-## [0.1.1] - 2023-02-16
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.1.2...HEAD)
 
-Changes
-- updated to OpenAI gem 3.0
+**Closed issues:**
 
-## [0.1.0] - 2023-02-15
+- Make sure the yard docs are up to date and have coverage [\#7](https://github.com/BoxcarsAI/boxcars/issues/7)
+- Specs need environment variables to be set to run green [\#4](https://github.com/BoxcarsAI/boxcars/issues/4)
 
-- Initial release
+**Merged pull requests:**
+
+- Get GitHub Actions to green [\#5](https://github.com/BoxcarsAI/boxcars/pull/5) ([petergoldstein](https://github.com/petergoldstein))
+- Fix typo introduced by merge.  Pull publish-rubygem into its own job [\#3](https://github.com/BoxcarsAI/boxcars/pull/3) ([petergoldstein](https://github.com/petergoldstein))
+
+## [v0.1.2](https://github.com/BoxcarsAI/boxcars/tree/v0.1.2) (2023-02-17)
+
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.1.1...v0.1.2)
+
+**Merged pull requests:**
+
+- Run GitHub Actions against multiple Rubies [\#2](https://github.com/BoxcarsAI/boxcars/pull/2) ([petergoldstein](https://github.com/petergoldstein))
+- \[infra\] Added deployment step for the RubyGems [\#1](https://github.com/BoxcarsAI/boxcars/pull/1) ([AKovtunov](https://github.com/AKovtunov))
+
+## [v0.1.1](https://github.com/BoxcarsAI/boxcars/tree/v0.1.1) (2023-02-16)
+
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.1.0...v0.1.1)
+
+## [v0.1.0](https://github.com/BoxcarsAI/boxcars/tree/v0.1.0) (2023-02-15)
+
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/e3c50bdc76f71c6d2abb012c38174633a5847028...v0.1.0)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -22,3 +22,5 @@ gem "rubocop-rspec", "~> 2.17"
 gem "sqlite3", "~> 1.6"
 
 gem "activerecord", "~> 7.0"
+
+gem "github_changelog_generator", "~> 1.16"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boxcars (0.1.2)
+    boxcars (0.1.3)
       google_search_results (~> 2.2)
       ruby-openai (~> 3.0)
 
@@ -21,7 +21,28 @@ GEM
     addressable (2.8.1)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    async (1.30.3)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    async-http (0.60.1)
+      async (>= 1.25)
+      async-io (>= 1.28)
+      async-pool (>= 0.2)
+      protocol-http (~> 0.24.0)
+      protocol-http1 (~> 0.15.0)
+      protocol-http2 (~> 0.15.0)
+      traces (>= 0.8.0)
+    async-http-faraday (0.11.0)
+      async-http (~> 0.42)
+      faraday
+    async-io (1.34.3)
+      async
+    async-pool (0.3.12)
+      async (>= 1.25)
     concurrent-ruby (1.2.0)
+    console (1.16.2)
+      fiber-local
     crack (0.4.5)
       rexml
     debug (1.7.1)
@@ -29,6 +50,22 @@ GEM
       reline (>= 0.3.1)
     diff-lcs (1.5.0)
     dotenv (2.8.1)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-http-cache (2.4.1)
+      faraday (>= 0.8)
+    faraday-net_http (3.0.2)
+    fiber-local (1.0.0)
+    github_changelog_generator (1.16.4)
+      activesupport
+      async (>= 1.25.0)
+      async-http-faraday
+      faraday-http-cache
+      multi_json
+      octokit (~> 4.6)
+      rainbow (>= 2.2.1)
+      rake (>= 10.0)
     google_search_results (2.2.0)
     hashdiff (1.0.1)
     httparty (0.21.0)
@@ -37,15 +74,31 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     io-console (0.6.0)
+    io-console (0.6.0-java)
     irb (1.6.2)
       reline (>= 0.3.0)
     json (2.6.3)
+    json (2.6.3-java)
     mini_mime (1.1.2)
+    mini_portile2 (2.8.1)
     minitest (5.17.0)
+    multi_json (1.15.0)
     multi_xml (0.6.0)
+    nio4r (2.5.8)
+    nio4r (2.5.8-java)
+    octokit (4.25.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
     parallel (1.22.1)
     parser (3.2.1.0)
       ast (~> 2.4.1)
+    protocol-hpack (1.4.2)
+    protocol-http (0.24.1)
+    protocol-http1 (0.15.0)
+      protocol-http (~> 0.22)
+    protocol-http2 (0.15.1)
+      protocol-hpack (~> 1.4)
+      protocol-http (~> 0.18)
     public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
@@ -88,8 +141,16 @@ GEM
     ruby-openai (3.3.0)
       httparty (>= 0.18.1)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    sqlite3 (1.6.0)
+      mini_portile2 (~> 2.8.0)
     sqlite3 (1.6.0-x86_64-darwin)
     sqlite3 (1.6.0-x86_64-linux)
+    timers (4.3.5)
+    traces (0.8.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
@@ -100,6 +161,7 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  universal-java-11
   x86_64-darwin-21
   x86_64-darwin-22
   x86_64-linux
@@ -109,6 +171,7 @@ DEPENDENCIES
   boxcars!
   debug (~> 1.1)
   dotenv (~> 2.8)
+  github_changelog_generator (~> 1.16)
   rake (~> 13.0)
   rspec (~> 3.2)
   rubocop (~> 1.21)

data/README.md

@@ -8,9 +8,8 @@ The popular python library langchain is a precursor to this work, but we wanted
 All of these concepts are in a module named Boxcars:
 - Prompt: a prompt is used by an Engine to generate text results.
 - Engine: an entity that generates text from a Prompt.
-- Boxcar: an encapsulation that does one thing (search, math, SQL, etc) and a many use an Engine to get their work accomplished.
-- Conductor: given a list of Boxcars and an Engine, an answer if found by breaking the promlem into peices for an indvidual Boxcar to solve. This is all joined back together to yield a final result. There is currently only one implementation - ZeroShot.
-- ConductorExecutor: manages the running of a Conductor.
+- Boxcar: an encapsulation that does one thing (search, math, SQL, etc) and a many use an Engine to get their work accomplished.cc
+- Train: given a list of Boxcars and an Engine, an answer if found by breaking the promlem into peices for an indvidual Boxcar to solve. This is all joined back together to yield a final result. There is currently only one implementation - ZeroShot. You can construct it directly, or just use `Boxcars::default_train`
 
 ## Installation
 
@@ -35,20 +34,35 @@ We will document many more examples soon, but here are a couple. The first step
 In the examples below, we added one rubygem to load the environment at the first line, but depending on what you want, you might not need this.
 ```ruby
 require "dotenv/load"
+require "boxcars"
 ```
 
 ### Direct Boxcar Use
 
 ```ruby
 # run the calculator
-require "dotenv/load"
-require "boxcars"
-
-engine = Boxcars::Openai.new
+engine = Boxcars::Openai.new(max_tokens: 256)
 calc = Boxcars::Calculator.new(engine: engine)
 puts calc.run "what is pi to the forth power divided by 22.1?"
 ```
+This segment above (try it by pasting into an `irb` session)
+```text
+> Entering Calculator#run
+what is pi to the forth power divided by 22.1?
+RubyREPL: puts(Math::PI**4 / 22.1)
+Answer: 4.407651178009159
+
+4.407651178009159
+< Exiting Calculator#run
+4.407651178009159
+```
 
+Note that since Openai is currently the most used Engine, if you do not pass in an engine, it will default as expected. So, this is the equialent shorter version of the above script:
+```ruby
+# run the calculator
+calc = Boxcars::Calculator.new # just use the default Engine
+puts calc.run "what is pi to the forth power divided by 22.1?"
+```
 ### Boxcars currently implemmented
 
 Here is what we have so far, but please put up a PR with your new ideas.
@@ -58,16 +72,30 @@ Here is what we have so far, but please put up a PR with your new ideas.
 
 ### Run a list of Boxcars
 ```ruby
-# run a Conductor for a calculator, and search 
-require "dotenv/load"
-require "boxcars"
-
-engine = Boxcars::Openai.new
-calc = Boxcars::Calculator.new(engine: engine)
-search = Boxcars::Serp.new
-cond = Boxcars::ZeroShot.new(engine: engine, boxcars: [calc, search])
-cexe = Boxcars::ConductorExecuter.new(conductor: cond)
-puts cexe.run "What is pi times the square root of the average temperature in Austin TX in January?"
+# run a Train for a calculator, and search using default Engine
+boxcars = [Boxcars::Calculator.new, Boxcars::Serp.new]
+train = Boxcars.default_train.new(boxcars: boxcars)
+puts train.run "What is pi times the square root of the average temperature in Austin TX in January?"
+```
+This outputs:
+```text
+> Entering Zero Shot#run
+What is pi times the square root of the average temperature in Austin TX in January?
+Question: Average temperature in Austin TX in January
+Answer: increase from 62°F to 64°F
+#Observation: increase from 62°F to 64°F
+> Entering Calculator#run
+64°F x pi
+RubyREPL: puts (64 * Math::PI).round(2)
+Answer: 201.06
+
+201.06
+< Exiting Calculator#run
+#Observation: 201.06
+I now know the final answer
+Final Answer: 201.06
+< Exiting Zero Shot#run
+201.06
 ```
 
 ## Development

data/Rakefile

@@ -10,3 +10,10 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
+
+require 'github_changelog_generator/task'
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'BoxcarsAI'
+  config.project = 'boxcars'
+end

data/boxcars.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email = ["hi@boxcars.ai"]
 
   spec.summary = "Boxcars provide an API to connect together Boxcars and then conduct them. Inspired by python langchain."
-  spec.description = "You simply give a number of boxcars to a conductor, and it does the magic."
+  spec.description = "You simply give a number of boxcars to a train, and it does the magic."
   spec.homepage = "https://github.com/BoxcarsAI/boxcars"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"

data/lib/boxcars/boxcar/calculator.rb

@@ -8,7 +8,7 @@ module Boxcars
     CALCDESC = "useful for when you need to answer questions about math"
     attr_accessor :input_key
 
-    # @param engine [Boxcars::Engine] The engine to user for this boxcar. Can be inherited from a conductor if nil.
+    # @param engine [Boxcars::Engine] The engine to user for this boxcar. Can be inherited from a train if nil.
     # @param prompt [Boxcars::Prompt] The prompt to use for this boxcar. Defaults to built-in prompt.
     # @param input_key [Symbol] The key to use for the input. Defaults to :question.
     # @param output_key [Symbol] The key to use for the output. Defaults to :answer.
@@ -63,7 +63,9 @@ module Boxcars
       end
     end
 
-    TEMPLATE = <<~IPT
+    # our template
+    # rubocop:disable Style/RedundantHeredocDelimiterQuotes
+    TEMPLATE = <<~'IPT'
       You are GPT-3, and you can't do math.
       You can do basic math, and your memorization abilities are impressive, but you can't do any complex calculations that a human could not do in their head. You also have an annoying tendency to just make up highly specific, but wrong, answers.
       So we hooked you up to a Ruby 3 kernel, and now you can execute ruby code. If anyone gives you a hard math problem, just use this format and we’ll take care of the rest:
@@ -98,6 +100,7 @@ module Boxcars
 
       Question: %<question>s
     IPT
+    # rubocop:enable Style/RedundantHeredocDelimiterQuotes
 
     # The prompt to use for the engine.
     def my_prompt

data/lib/boxcars/boxcar/engine_boxcar.rb

@@ -3,17 +3,17 @@
 # Boxcars is a framework for running a series of tools to get an answer to a question.
 module Boxcars
   # For Boxcars that use an engine to do their work.
-  class EngineBoxcar < Boxcars::Boxcar
+  class EngineBoxcar < Boxcar
     attr_accessor :prompt, :engine, :output_key
 
     # A Boxcar is a container for a single tool to run.
     # @param prompt [Boxcars::Prompt] The prompt to use for this boxcar with sane defaults.
     # @param name [String] The name of the boxcar. Defaults to classname.
     # @param description [String] A description of the boxcar.
-    # @param engine [Boxcars::Engine] The engine to user for this boxcar. Can be inherited from a conductor if nil.
-    def initialize(prompt:, engine:, output_key: "text", name: nil, description: nil)
+    # @param engine [Boxcars::Engine] The engine to user for this boxcar. Can be inherited from a train if nil.
+    def initialize(prompt:, engine: nil, output_key: "text", name: nil, description: nil)
       @prompt = prompt
-      @engine = engine
+      @engine = engine || Boxcars.default_engine.new
       @output_key = output_key
       super(name: name, description: description)
     end
@@ -36,7 +36,7 @@ module Boxcars
       prompts = []
       input_list.each do |inputs|
         new_prompt = prompt.format(**inputs)
-        puts "Prompt after formatting:\n#{new_prompt.colorize(:cyan)}"
+        puts "Prompt after formatting:\n#{new_prompt.colorize(:cyan)}" if Boxcars.configuration.log_prompts
         prompts.push(new_prompt)
       end
       engine.generate(prompts: prompts, stop: stop)

data/lib/boxcars/boxcar/sql.rb

@@ -9,7 +9,7 @@ module Boxcars
     attr_accessor :connection, :input_key
 
     # @param connection [ActiveRecord::Connection] The SQL connection to use for this boxcar.
-    # @param engine [Boxcars::Engine] The engine to user for this boxcar. Can be inherited from a conductor if nil.
+    # @param engine [Boxcars::Engine] The engine to user for this boxcar. Can be inherited from a train if nil.
     # @param input_key [Symbol] The key to use for the input. Defaults to :question.
     # @param output_key [Symbol] The key to use for the output. Defaults to :answer.
     # @param kwargs [Hash] Any other keyword arguments to pass to the parent class. This can include

data/lib/boxcars/boxcar.rb

@@ -11,7 +11,7 @@ module Boxcars
     # @param return_direct [Boolean] If true, return the output of this boxcar directly, without merging it with the inputs.
     def initialize(description:, name: nil, return_direct: false)
       @name = name || self.class.name
-      @description = description
+      @description = description || @name
       @return_direct = return_direct
     end
 
@@ -53,7 +53,7 @@ module Boxcars
     # @param input_list [Array<Hash>] The list of inputs.
     # @return [Array<Boxcars::Boxcar>] The list of outputs.
     def apply(input_list:)
-      input_list.map { |inputs| new(**inputs) }
+      raise NotImplementedError
     end
 
     # Get an answer from the boxcar.
@@ -62,9 +62,9 @@ module Boxcars
     # you can pass one or the other, but not both.
     # @return [String] The answer to the question.
     def run(*args, **kwargs)
-      puts "> Enterning #{name} boxcar#run".colorize(:gray, style: :bold)
+      puts "> Entering #{name}#run".colorize(:gray, style: :bold)
       rv = do_run(*args, **kwargs)
-      puts "< Exiting #{name} boxcar#run".colorize(:gray, style: :bold)
+      puts "< Exiting #{name}#run".colorize(:gray, style: :bold)
       rv
     end
 

data/lib/boxcars/{conductor/conductor_action.rb → train/train_action.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Boxcars
-  # Conductor's action to take.
-  class ConductorAction
+  # Train's action to take.
+  class TrainAction
     attr_accessor :boxcar, :boxcar_input, :log
 
     def initialize(boxcar: nil, boxcar_input: nil, log: nil)

data/lib/boxcars/{conductor/conductor_finish.rb → train/train_finish.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Boxcars
-  # Conductor's return value
-  class ConductorFinish
+  # Train's return value
+  class TrainFinish
     attr_accessor :return_values, :log
 
     def initialize(return_values, log:)

data/lib/boxcars/{conductor → train}/zero_shot.rb

@@ -1,7 +1,7 @@
 # Agent for the MRKL chain
 module Boxcars
-  # A Conductor using the zero-shot react method.
-  class ZeroShot < Conductor
+  # A Train using the zero-shot react method.
+  class ZeroShot < Train
     attr_reader :boxcars, :observation_prefix, :engine_prefix
 
     # default prompt prefix
@@ -30,10 +30,10 @@ module Boxcars
     SINPUT
 
     # @param boxcars [Array<Boxcars::Boxcar>] The boxcars to run.
-    # @param engine [Boxcars::Engine] The engine to use for this conductor.
-    # @param name [String] The name of the conductor. Defaults to 'Zero Shot'.
-    # @param description [String] The description of the conductor. Defaults to 'Zero Shot Conductor'.
-    def initialize(boxcars:, engine:, name: 'Zero Shot', description: 'Zero Shot Conductor')
+    # @param engine [Boxcars::Engine] The engine to use for this train.
+    # @param name [String] The name of the train. Defaults to 'Zero Shot'.
+    # @param description [String] The description of the train. Defaults to 'Zero Shot Train'.
+    def initialize(boxcars:, engine: nil, name: 'Zero Shot', description: 'Zero Shot Train')
       @observation_prefix = 'Observation: '
       @engine_prefix = 'Thought:'
       prompt = self.class.create_prompt(boxcars: boxcars)

data/lib/boxcars/{conductor.rb → train.rb}

@@ -2,28 +2,24 @@
 
 module Boxcars
   # @abstract
-  class Conductor
-    attr_reader :engine, :boxcars, :name, :description, :prompt, :engine_boxcar, :return_values
+  class Train < EngineBoxcar
+    attr_reader :engine, :boxcars, :name, :description, :prompt, :return_values, :return_intermediate_steps,
+                :max_iterations, :early_stopping_method
 
-    # A Conductor will use a engine to run a series of boxcars.
-    # @param engine [Boxcars::Engine] The engine to use for this conductor.
+    # A Train will use a engine to run a series of boxcars.
+    # @param engine [Boxcars::Engine] The engine to use for this train.
     # @param boxcars [Array<Boxcars::Boxcar>] The boxcars to run.
+    # @param prompt [String] The prompt to use.
     # @abstract
-    def initialize(engine:, boxcars:, prompt:, name: nil, description: nil)
-      @engine = engine
+    def initialize(boxcars:, prompt:, engine: nil, **kwargs)
       @boxcars = boxcars
-      @prompt = prompt
       @name = name || self.class.name
-      @description = description
       @return_values = [:output]
-      @engine_boxcar = EngineBoxcar.new(prompt: prompt, engine: engine)
-    end
+      @return_intermediate_steps = kwargs[:return_intermediate_steps] || false
+      @max_iterations = kwargs[:max_iterations]
+      @early_stopping_method = kwargs[:early_stopping_method] || "force"
 
-    # Get an answer from the conductor.
-    # @param question [String] The question to ask the conductor.
-    # @return [String] The answer to the question.
-    def run(question)
-      raise NotImplementedError
+      super(prompt: prompt, engine: engine, name: kwargs[:name], description: kwargs[:description])
     end
 
     # Extract the boxcar name and input from the text.
@@ -52,16 +48,16 @@ module Boxcars
     # @param full_inputs [Hash] The inputs to the engine.
     # @return [Boxcars::Action] The next action.
     def get_next_action(full_inputs)
-      full_output = engine_boxcar.predict(**full_inputs)
+      full_output = predict(**full_inputs)
       parsed_output = extract_boxcar_and_input(full_output)
       while parsed_output.nil?
         full_output = _fix_text(full_output)
         full_inputs[:agent_scratchpad] += full_output
-        output = engine_boxcar.predict(**full_inputs)
+        output = predict(**full_inputs)
         full_output += output
         parsed_output = extract_boxcar_and_input(full_output)
       end
-      ConductorAction.new(boxcar: parsed_output[0], boxcar_input: parsed_output[1], log: full_output)
+      TrainAction.new(boxcar: parsed_output[0], boxcar_input: parsed_output[1], log: full_output)
     end
 
     # Given input, decided what to do.
@@ -73,7 +69,7 @@ module Boxcars
       new_inputs = { agent_scratchpad: thoughts, stop: stop }
       full_inputs = kwargs.merge(new_inputs)
       action = get_next_action(full_inputs)
-      return ConductorFinish.new({ output: action.boxcar_input }, log: action.log) if action.boxcar == finish_boxcar_name
+      return TrainFinish.new({ output: action.boxcar_input }, log: action.log) if action.boxcar == finish_boxcar_name
 
       action
     end
@@ -95,12 +91,38 @@ module Boxcars
       list
     end
 
-    # Check that all inputs are present.
-    # @param inputs [Hash] The inputs to check.
-    # @raise [RuntimeError] If any inputs are missing.
-    def validate_inputs(inputs:)
-      missing_keys = input_keys - inputs.keys
-      raise "Missing some input keys: #{missing_keys}" if missing_keys.any?
+    # the output keys
+    def output_keys
+      return return_values + ["intermediate_steps"] if return_intermediate_steps
+
+      return_values
+    end
+
+    # should we continue to run?
+    # @param iterations [Integer] The number of iterations.
+    # @return [Boolean] Whether to continue.
+    def should_continue?(iterations)
+      return true if max_iterations.nil?
+
+      iterations < max_iterations
+    end
+
+    # handler before returning
+    # @param output [Boxcars::TrainFinish] The output.
+    # @param intermediate_steps [Array<Hash>] The intermediate steps.
+    # @return [Hash] The final output.
+    def pre_return(output, intermediate_steps)
+      puts output.log.colorize(:yellow)
+      final_output = output.return_values
+      final_output["intermediate_steps"] = intermediate_steps if return_intermediate_steps
+      final_output
+    end
+
+    # the prefix for the engine
+    # @param return_direct [Boolean] Whether to return directly.
+    # @return [String] The prefix.
+    def engine_prefix(return_direct)
+      return_direct ? "" : engine_prefix
     end
 
     # validate the prompt
@@ -113,10 +135,10 @@ module Boxcars
         logger.warning("`agent_scratchpad` should be a variable in prompt.input_variables. Not found, adding it at the end.")
         prompt.input_variables.append(:agent_scratchpad)
         case prompt
-        when PromptTemplate
+        when Prompt
           prompt.template += "\n%<agent_scratchpad>s"
-        when FewShotPromptTemplate
-          prompt.suffix += "\n%<agent_scratchpad>s"
+        # when FewShotPromptTemplate
+        #   prompt.suffix += "\n%<agent_scratchpad>s"
         else
           raise ValueError, "Got unexpected prompt type #{type(prompt)}"
         end
@@ -132,7 +154,7 @@ module Boxcars
     def return_stopped_response(early_stopping_method, intermediate_steps, **kwargs)
       case early_stopping_method
       when "force"
-        ConductorFinish({ output: "Agent stopped due to max iterations." }, "")
+        TrainFinish({ output: "Agent stopped due to max iterations." }, "")
       when "generate"
         thoughts = ""
         intermediate_steps.each do |action, observation|
@@ -142,26 +164,61 @@ module Boxcars
         thoughts += "\n\nI now need to return a final answer based on the previous steps:"
         new_inputs = { agent_scratchpad: thoughts, stop: _stop }
         full_inputs = kwargs.merge(new_inputs)
-        full_output = engine_boxcar.predict(**full_inputs)
+        full_output = predict(**full_inputs)
         parsed_output = extract_boxcar_and_input(full_output)
         if parsed_output.nil?
-          ConductorFinish({ output: full_output }, full_output)
+          TrainFinish({ output: full_output }, full_output)
         else
           boxcar, boxcar_input = parsed_output
           if boxcar == finish_boxcar_name
-            ConductorFinish({ output: boxcar_input }, full_output)
+            TrainFinish({ output: boxcar_input }, full_output)
           else
-            ConductorFinish({ output: full_output }, full_output)
+            TrainFinish({ output: full_output }, full_output)
           end
         end
       else
         raise "early_stopping_method should be one of `force` or `generate`, got #{early_stopping_method}"
       end
     end
+
+    # execute the train train
+    # @param inputs [Hash] The inputs.
+    # @return [Hash] The output.
+    def call(inputs:)
+      prepare_for_new_call
+      name_to_boxcar_map = boxcars.to_h { |boxcar| [boxcar.name, boxcar] }
+      intermediate_steps = []
+      iterations = 0
+      while should_continue?(iterations)
+        output = plan(intermediate_steps, **inputs)
+        return pre_return(output, intermediate_steps) if output.is_a?(TrainFinish)
+
+        if (boxcar = name_to_boxcar_map[output.boxcar])
+          begin
+            observation = boxcar.run(output.boxcar_input)
+            return_direct = boxcar.return_direct
+          rescue StandardError => e
+            puts "Error in #{boxcar.name} boxcar#call: #{e}".colorize(:red)
+            raise e
+          end
+        else
+          observation = "#{output.boxcar} is not a valid boxcar, try another one."
+          return_direct = false
+        end
+        puts "#Observation: #{observation}".colorize(:green)
+        intermediate_steps.append([output, observation])
+        if return_direct
+          output = TrainFinish.new({ return_values[0] => observation }, "")
+          return pre_return(output, intermediate_steps)
+        end
+        iterations += 1
+      end
+      output = return_stopped_response(early_stopping_method, intermediate_steps, **inputs)
+      pre_return(output, intermediate_steps)
+    end
   end
 end
 
-require "boxcars/conductor/conductor_action"
-require "boxcars/conductor/conductor_finish"
-require "boxcars/conductor/conductor_executer"
-require "boxcars/conductor/zero_shot"
+require "boxcars/train/train_action"
+require "boxcars/train/train_finish"
+require "boxcars/train/zero_shot"

data/lib/boxcars/version.rb

@@ -2,5 +2,5 @@
 
 module Boxcars
   # The current version of the gem.
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/boxcars.rb

@@ -36,12 +36,13 @@ module Boxcars
   # Configuration contains gem settings
   class Configuration
     attr_writer :openai_access_token, :serpapi_api_key
-    attr_accessor :organization_id, :logger
+    attr_accessor :organization_id, :logger, :log_prompts
 
     def initialize
       @organization_id = nil
       @logger = Rails.logger if defined?(Rails)
       @logger ||= Logger.new($stdout)
+      @log_prompts = false
     end
 
     # @return [String] The OpenAI Access Token either from arg or env.
@@ -93,6 +94,16 @@ module Boxcars
   def self.configure
     yield(configuration)
   end
+
+  # Return the default Train class.
+  def self.default_train
+    Boxcars::ZeroShot
+  end
+
+  # Return the default Engine class.
+  def self.default_engine
+    Boxcars::Openai
+  end
 end
 
 require "boxcars/version"
@@ -101,4 +112,4 @@ require "boxcars/generation"
 require "boxcars/ruby_repl"
 require "boxcars/engine"
 require "boxcars/boxcar"
-require "boxcars/conductor"
+require "boxcars/train"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxcars
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Francis Sullivan
@@ -81,7 +81,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: You simply give a number of boxcars to a conductor, and it does the magic.
+description: You simply give a number of boxcars to a train, and it does the magic.
 email:
 - hi@boxcars.ai
 executables: []
@@ -106,17 +106,16 @@ files:
 - lib/boxcars/boxcar/engine_boxcar.rb
 - lib/boxcars/boxcar/serp.rb
 - lib/boxcars/boxcar/sql.rb
-- lib/boxcars/conductor.rb
-- lib/boxcars/conductor/conductor_action.rb
-- lib/boxcars/conductor/conductor_executer.rb
-- lib/boxcars/conductor/conductor_finish.rb
-- lib/boxcars/conductor/zero_shot.rb
 - lib/boxcars/engine.rb
 - lib/boxcars/engine/engine_result.rb
 - lib/boxcars/engine/openai.rb
 - lib/boxcars/generation.rb
 - lib/boxcars/prompt.rb
 - lib/boxcars/ruby_repl.rb
+- lib/boxcars/train.rb
+- lib/boxcars/train/train_action.rb
+- lib/boxcars/train/train_finish.rb
+- lib/boxcars/train/zero_shot.rb
 - lib/boxcars/version.rb
 homepage: https://github.com/BoxcarsAI/boxcars
 licenses:

data/lib/boxcars/conductor/conductor_executer.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-module Boxcars
-  # Consists of an conductor using boxcars.
-  class ConductorExecuter < EngineBoxcar
-    attr_accessor :conductor, :boxcars, :return_intermediate_steps, :max_iterations, :early_stopping_method
-
-    # @param conductor [Boxcars::Conductor] The conductor to use.
-    # @param boxcars [Array<Boxcars::Boxcar>] The boxcars to use.
-    # @param return_intermediate_steps [Boolean] Whether to return the intermediate steps. Defaults to false.
-    # @param max_iterations [Integer] The maximum number of iterations to run. Defaults to nil.
-    # @param early_stopping_method [String] The early stopping method to use. Defaults to "force".
-    def initialize(conductor:, boxcars: nil, return_intermediate_steps: false, max_iterations: nil,
-                   early_stopping_method: "force")
-      @conductor = conductor
-      @boxcars = boxcars || conductor.boxcars
-      @return_intermediate_steps = return_intermediate_steps
-      @max_iterations = max_iterations
-      @early_stopping_method = early_stopping_method
-      # def initialize(prompt:, engine:, output_key: "text", name: nil, description: nil)
-      super(prompt: conductor.prompt, engine: conductor.engine, name: conductor.name, description: conductor.description)
-    end
-
-    # is this the same list of boxcars?
-    # @param boxcar_names [Array<String>] The boxcar names to compare.
-    # @return [Boolean] Whether the boxcars are the same.
-    def same_boxcars?(boxcar_names)
-      conductor.allowed_boxcars.sort == boxcar_names
-    end
-
-    # validate the boxcars
-    # @raise [RuntimeError] If the boxcars are not the same.
-    def validate_boxcars
-      boxcar_names = boxcars.map(&:name).sort
-      return if same_boxcars?(boxcar_names)
-
-      raise "Allowed boxcars (#{conductor.allowed_boxcars}) different than provided boxcars (#{boxcar_names})"
-    end
-
-    # the input keys
-    def input_keys
-      conductor.input_keys
-    end
-
-    # the output keys
-    def output_keys
-      return conductor.return_values + ["intermediate_steps"] if return_intermediate_steps
-
-      conductor.return_values
-    end
-
-    # should we continue to run?
-    # @param iterations [Integer] The number of iterations.
-    # @return [Boolean] Whether to continue.
-    def should_continue?(iterations)
-      return true if max_iterations.nil?
-
-      iterations < max_iterations
-    end
-
-    # handler before returning
-    # @param output [Boxcars::ConductorFinish] The output.
-    # @param intermediate_steps [Array<Hash>] The intermediate steps.
-    # @return [Hash] The final output.
-    def pre_return(output, intermediate_steps)
-      puts output.log.colorize(:yellow)
-      final_output = output.return_values
-      final_output["intermediate_steps"] = intermediate_steps if return_intermediate_steps
-      final_output
-    end
-
-    # the prefix for the engine
-    # @param return_direct [Boolean] Whether to return directly.
-    # @return [String] The prefix.
-    def engine_prefix(return_direct)
-      return_direct ? "" : conductor.engine_prefix
-    end
-
-    # call the conductor
-    # @param inputs [Hash] The inputs.
-    # @return [Hash] The output.
-    def call(inputs:)
-      conductor.prepare_for_new_call
-      name_to_boxcar_map = boxcars.to_h { |boxcar| [boxcar.name, boxcar] }
-      intermediate_steps = []
-      iterations = 0
-      while should_continue?(iterations)
-        output = conductor.plan(intermediate_steps, **inputs)
-        return pre_return(output, intermediate_steps) if output.is_a?(ConductorFinish)
-
-        if (boxcar = name_to_boxcar_map[output.boxcar])
-          begin
-            observation = boxcar.run(output.boxcar_input)
-            return_direct = boxcar.return_direct
-          rescue StandardError => e
-            puts "Error in #{boxcar.name} boxcar#call: #{e}".colorize(:red)
-            raise e
-          end
-        else
-          observation = "#{output.boxcar} is not a valid boxcar, try another one."
-          return_direct = false
-        end
-        puts "#Observation: #{observation}".colorize(:green)
-        intermediate_steps.append([output, observation])
-        if return_direct
-          output = ConductorFinish.new({ conductor.return_values[0] => observation }, "")
-          return pre_return(output, intermediate_steps)
-        end
-        iterations += 1
-      end
-      output = conductor.return_stopped_response(early_stopping_method, intermediate_steps, **inputs)
-      pre_return(output, intermediate_steps)
-    end
-  end
-end