nano-bots 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 158748eddde7df19233111d423ade5a4ce8d5eccc0e846fefa3c83aa02bdb1f0
-  data.tar.gz: 57451266dd04a90fd0df74f49886ad940d58543dc3d0225ceeb548c08bdc93e8
+  metadata.gz: ed836839edfabe16e119f3f7e52ad82fbef851885d5adbb5b3097620d0491bfb
+  data.tar.gz: a4f909df92cb62b9d5882ad3c9419e0c4560a15f251fa37aae92814b0e586143
 SHA512:
-  metadata.gz: 3e73d11ccd1d49abfb54779069a4a6a802ad21041ce09832221840353a799f358141db46f54e5eccd0416ea3f5ccda7c65c657022a3e6dd0e41ba1fcab91a429
-  data.tar.gz: ec1bf4b5d26f57a95f931f23e98db0288af2883cb27d7bc1447ac4c65ab1052d7a4e9779b947c522e3f4c6a91ae1ca9f2f9a7c6c5ec8c0001c6019d2efa848ad
+  metadata.gz: 2c8f39d6d1b0362fb936b0ee0d3df73a6efb77ee3cb86c17c754f1a129d38c01034c2deff7f37f16143a17c28446fc4ebd868e047aaf616ab298b61d0310fa4e
+  data.tar.gz: 61ec7033e15173f2c74aeb830b48dcfaac676f7be282f3ebede3c198e710c7b92caad92649ddc84b7e3e665de2a74b4417c260aebb63caa0e0d0a3b7cdfb6fa6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nano-bots (0.0.2)
+    nano-bots (0.0.3)
       babosa (~> 2.0)
       dotenv (~> 2.8, >= 2.8.1)
       faraday (~> 2.7, >= 2.7.4)
@@ -48,7 +48,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.50.2)
+    rubocop (1.51.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)

data/README.md

@@ -13,6 +13,8 @@ https://user-images.githubusercontent.com/113217272/237840989-1e29a5cc-6644-48d0
   - [Command Line](#command-line)
   - [Library](#library)
 - [Cartridges](#cartridges)
+- [Providers](#providers)
+- [Debugging](#debugging)
 - [Development](#development)
   - [Publish to RubyGems](#publish-to-rubygems)
 
@@ -21,13 +23,13 @@ https://user-images.githubusercontent.com/113217272/237840989-1e29a5cc-6644-48d0
 For a system usage:
 
 ```sh
-gem install nano-bots -v 0.0.2
+gem install nano-bots -v 0.0.3
 ```
 
 To use it in a project, add it to your `Gemfile`:
 
 ```ruby
-gem 'nano-bots', '~> 0.0.2'
+gem 'nano-bots', '~> 0.0.3'
 ```
 
 ```sh
@@ -41,11 +43,20 @@ export OPENAI_API_ADDRESS=https://api.openai.com
 export OPENAI_API_ACCESS_TOKEN=your-token
 export OPENAI_API_USER_IDENTIFIER=your-user
 
-export NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots
-export NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges
+# export NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots
+# export NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges
 ```
 
-Alternatively, if your current directory has a `.env` file with the environment variables, they will be automatically loaded.
+Alternatively, if your current directory has a `.env` file with the environment variables, they will be automatically loaded:
+
+```sh
+OPENAI_API_ADDRESS=https://api.openai.com
+OPENAI_API_ACCESS_TOKEN=your-token
+OPENAI_API_USER_IDENTIFIER=your-user
+
+# NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots
+# NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges
+```
 
 ## Docker
 
@@ -65,13 +76,14 @@ version: '3.7'
 services:
   nano-bots:
     image: ruby:3.2.2-slim-bullseye
-    command: sh -c "gem install nano-bots -v 0.0.2 && bash"
+    command: sh -c "gem install nano-bots -v 0.0.3 && bash"
     environment:
       OPENAI_API_ADDRESS: https://api.openai.com
       OPENAI_API_ACCESS_TOKEN: your-token
       OPENAI_API_USER_IDENTIFIER: your-user
     volumes:
       - ./your-cartridges:/cartridges
+      # - ./your-data:/data
 ```
 
 Enter the container:
@@ -81,6 +93,10 @@ docker compose run nano-bots
 
 Start playing:
 ```sh
+nb - - eval "hello"
+nb - - repl
+
+nb cartridges/assistant.yml - eval "hello"
 nb cartridges/assistant.yml - repl
 ```
 
@@ -93,6 +109,9 @@ After installing the gem, the `nb` binary command will be available for your pro
 Examples of usage:
 
 ```bash
+nb - - eval "hello"
+# => Hello! How may I assist you today?
+
 nb to-en-us-translator.yml - eval "Salut, comment ça va?"
 # => Hello, how are you doing?
 
@@ -115,6 +134,8 @@ cat article.txt |
 ```
 
 ```bash
+nb - - repl
+
 nb assistant.yml - repl
 ```
 
@@ -145,6 +166,16 @@ require 'securerandom'
 SecureRandom.hex # => 6ea6c43c42a1c076b1e3c36fa349ac2c
 ```
 
+### Debugging
+
+```sh
+nb - - cartridge
+nb cartridge.yml - cartridge
+
+nb - STATE-KEY state
+nb cartridge.yml STATE-KEY state
+```
+
 ### Library
 
 To use it as a library:
@@ -198,6 +229,16 @@ provider:
 
 Check the Nano Bots specification to learn more about [how to build cartridges](https://icebaker.github.io/nano-bots/#/README?id=cartridges).
 
+## Providers
+
+Currently supported providers:
+
+- [ ] [Vicuna](https://github.com/lm-sys/FastChat)
+- [x] [Open AI](https://platform.openai.com/docs/api-reference)
+- [ ] [Google PaLM](https://developers.generativeai.google/)
+- [ ] [Alpaca](https://github.com/tatsu-lab/stanford_alpaca)
+- [ ] [LLaMA](https://github.com/facebookresearch/llama)
+
 ## Development
 
 ```bash
@@ -213,5 +254,5 @@ gem build nano-bots.gemspec
 
 gem signin
 
-gem push nano-bots-0.0.2.gem
+gem push nano-bots-0.0.3.gem
 ```

data/components/storage.rb

@@ -19,7 +19,7 @@ module NanoBot
 
         path = "#{path.sub(%r{/$}, '')}/ruby-nano-bots/#{cartridge[:meta][:author].to_slug.normalize}"
         path = "#{path}/#{cartridge[:meta][:name].to_slug.normalize}"
-        path = "#{path}/#{cartridge[:meta][:version].to_s.gsub('.', '-').to_slug.normalize}/#{key.to_slug.normalize}"
+        path = "#{path}/#{cartridge[:meta][:version].to_s.gsub('.', '-').to_slug.normalize}/#{key}"
         path = "#{path}/state.json"
 
         FileUtils.mkdir_p(File.dirname(path))

data/controllers/instance.rb

@@ -12,35 +12,64 @@ require_relative './session'
 module NanoBot
   module Controllers
     class Instance
-      def initialize(cartridge_path:, state: nil)
+      def initialize(cartridge_path:, stream:, state: nil)
+        @stream = stream
+
         load_cartridge!(cartridge_path)
 
         provider = Components::Provider.new(@cartridge[:provider])
 
-        @session = Session.new(provider:, cartridge: @cartridge, state:)
+        @session = Session.new(provider:, cartridge: @cartridge, state:, stream: @stream)
+      end
+
+      def cartridge
+        puts YAML.dump(@safe_cartridge)
       end
 
-      def debug
-        @session.debug
+      def state
+        @session.state
       end
 
       def eval(input)
         Interfaces::Eval.evaluate(input, @cartridge, @session)
+
+        return unless @stream.is_a?(StringIO)
+
+        @stream.flush
+        result = @stream.string.clone
+        @stream.truncate(0)
+        @stream.rewind
+        result
       end
 
       def repl
+        if @stream.is_a?(StringIO)
+          @stream.flush
+          @stream = $stdout
+          @session.stream = @stream
+        end
         Interfaces::REPL.start(@cartridge, @session)
       end
 
       private
 
       def load_cartridge!(path)
-        @cartridge = Logic::Helpers::Hash.symbolize_keys(
-          YAML.safe_load(
-            File.read(Components::Storage.cartridge_path(path)),
-            permitted_classes: [Symbol]
-          )
-        )
+        elected_path = if path.strip == '-'
+                         File.expand_path('../static/cartridges/default.yml', __dir__)
+                       else
+                         Components::Storage.cartridge_path(path)
+                       end
+
+        if elected_path.nil?
+          @stream.write("Cartridge file not found: \"#{path}\"\n")
+          raise StandardError, "Cartridge file not found: \"#{path}\""
+        end
+
+        @cartridge = YAML.safe_load(File.read(elected_path), permitted_classes: [Symbol])
+
+        @safe_cartridge = Marshal.load(Marshal.dump(@cartridge))
+
+        @cartridge = Logic::Helpers::Hash.symbolize_keys(@cartridge)
 
         inject_environment_variables!(@cartridge)
       end

data/controllers/interfaces/cli.rb

@@ -13,20 +13,38 @@ module NanoBot
             puts NanoBot::GEM[:version]
             exit
           when 'help', '', nil
+            puts ''
             puts "Nano Bots #{NanoBot::GEM[:version]}"
-            puts '  nb cartridge.yml - eval "Hello"'
+            puts ''
+            puts '  nb - - eval "hello"'
+            puts '  nb - - repl'
+            puts ''
+            puts '  nb cartridge.yml - eval "hello"'
             puts '  nb cartridge.yml - repl'
-            puts '  nb cartridge.yml - debug'
-            puts '  nb cartridge.yml STATE-KEY eval "Hello"'
+            puts ''
+            puts '  nb - STATE-KEY eval "hello"'
+            puts '  nb - STATE-KEY repl'
+            puts ''
+            puts '  nb cartridge.yml STATE-KEY eval "hello"'
             puts '  nb cartridge.yml STATE-KEY repl'
-            puts '  nb cartridge.yml STATE-KEY debug'
+            puts ''
+            puts '  nb - - cartridge'
+            puts '  nb cartridge.yml - cartridge'
+            puts ''
+            puts '  nb - STATE-KEY state'
+            puts '  nb cartridge.yml STATE-KEY state'
+            puts ''
             puts '  nb version'
+            puts '  nb help'
+            puts ''
             exit
           end
 
           params = { cartridge_path: ARGV[0], state: ARGV[1], command: ARGV[2] }
 
-          bot = Instance.new(cartridge_path: params[:cartridge_path], state: params[:state])
+          bot = Instance.new(
+            cartridge_path: params[:cartridge_path], state: params[:state], stream: $stdout
+          )
 
           case params[:command]
           when 'eval'
@@ -35,8 +53,10 @@ module NanoBot
             bot.eval(params[:input])
           when 'repl'
             bot.repl
-          when 'debug'
-            bot.debug
+          when 'state'
+            bot.state
+          when 'cartridge'
+            bot.cartridge
           else
             raise "TODO: [#{params[:command]}]"
           end

data/controllers/session.rb

@@ -12,12 +12,13 @@ module NanoBot
     STREAM_TIMEOUT_IN_SECONDS = 5
 
     class Session
-      def initialize(provider:, cartridge:, state: nil)
+      attr_accessor :stream
+
+      def initialize(provider:, cartridge:, state: nil, stream: $stdout)
+        @stream = stream
         @provider = provider
         @cartridge = cartridge
 
-        @output = $stdout
-
         @stateless = state.nil? || state.strip == '-' || state.strip.empty?
 
         if @stateless
@@ -30,7 +31,7 @@ module NanoBot
         end
       end
 
-      def debug
+      def state
         pp({
              state: {
                path: @state_path,
@@ -67,7 +68,7 @@ module NanoBot
         process(input, mode:)
       end
 
-      def stream(interface)
+      def streaming(interface)
         provider = @provider.settings.key?(:stream) ? @provider.settings[:stream] : true
         interface = interface.key?(:stream) ? interface[:stream] : true
 
@@ -77,7 +78,7 @@ module NanoBot
       def process(input, mode:)
         interface = Logic::Helpers::Hash.fetch(@cartridge, [:interfaces, mode.to_sym]) || {}
 
-        streaming = stream(interface)
+        streaming = streaming(interface)
 
         input[:interface] = interface
 
@@ -105,11 +106,11 @@ module NanoBot
       end
 
       def flush
-        @output.flush
+        @stream.flush
       end
 
       def print(content)
-        @output.write(content)
+        @stream.write(content)
       end
     end
   end

data/docker-compose.example.yml

@@ -3,10 +3,11 @@ version: '3.7'
 services:
   nano-bots:
     image: ruby:3.2.2-slim-bullseye
-    command: sh -c "gem install nano-bots -v 0.0.2 && bash"
+    command: sh -c "gem install nano-bots -v 0.0.3 && bash"
     environment:
       OPENAI_API_ADDRESS: https://api.openai.com
       OPENAI_API_ACCESS_TOKEN: your-token
       OPENAI_API_USER_IDENTIFIER: your-user
     volumes:
       - ./your-cartridges:/cartridges
+      # - ./your-data:/data

data/ports/dsl/nano-bots.rb

@@ -7,16 +7,16 @@ require_relative '../../controllers/instance'
 require_relative '../../controllers/interfaces/cli'
 
 module NanoBot
-  def self.new(cartridge:, state: '-')
-    Controllers::Instance.new(cartridge_path: cartridge, state:)
+  def self.new(cartridge: '-', state: '-')
+    Controllers::Instance.new(cartridge_path: cartridge, state:, stream: StringIO.new)
   end
 
   def self.cli
     Controllers::Interfaces::CLI.handle!
   end
 
-  def self.repl(cartridge:, state: '-')
-    Controllers::Instance.new(cartridge_path: cartridge, state:).repl
+  def self.repl(cartridge: '-', state: '-')
+    Controllers::Instance.new(cartridge_path: cartridge, state:, stream: $stdout).repl
   end
 
   def self.version

data/static/cartridges/default.yml

@@ -0,0 +1,14 @@
+---
+meta:
+  name: Unknown
+  author: Nobody
+  version: 0.0.0
+
+provider:
+  name: openai
+  settings:
+    model: gpt-3.5-turbo
+    credentials:
+      address: ENV/OPENAI_API_ADDRESS
+      access-token: ENV/OPENAI_API_ACCESS_TOKEN
+      user-identifier: ENV/OPENAI_API_USER_IDENTIFIER

data/static/gem.rb

@@ -3,7 +3,7 @@
 module NanoBot
   GEM = {
     name: 'nano-bots',
-    version: '0.0.2',
+    version: '0.0.3',
     author: 'icebaker',
     summary: 'Ruby Implementation of Nano Bots: small, AI-powered bots',
     description: 'Ruby Implementation of Nano Bots: small, AI-powered bots easily shared as a single file, designed to support multiple providers such as Vicuna, OpenAI ChatGPT, Google PaLM, Alpaca, and LLaMA.',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nano-bots
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - icebaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2023-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: babosa
@@ -143,6 +143,7 @@ files:
 - nano-bots.gemspec
 - ports/dsl/nano-bots.rb
 - ports/dsl/nano-bots/cli.rb
+- static/cartridges/default.yml
 - static/gem.rb
 homepage: https://github.com/icebaker/ruby-nano-bots
 licenses: