nano-bots 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb32dfa429c178b7af6c3f9a4c8046846ab9ae894c94bbf2038644ceef9c2368
-  data.tar.gz: 21e37c25c085c27f0f0357f8bb878cba2a366641f9d4649dc25536bcd51afc28
+  metadata.gz: 158748eddde7df19233111d423ade5a4ce8d5eccc0e846fefa3c83aa02bdb1f0
+  data.tar.gz: 57451266dd04a90fd0df74f49886ad940d58543dc3d0225ceeb548c08bdc93e8
 SHA512:
-  metadata.gz: 0a4a1f1a7f33eb6da088b8418cd0d4da61d8e6890ee8b6a0276330217164966b7266c032eabf3e3454e7879bd5e525b47cc99eff40259b7a1a9f9cf86a72db4f
-  data.tar.gz: 2098e8e5da98da2499ea4267e70be61ba9a06feb5c3fb6375d8ff05dbd01ae72134d34e5205884af80f3c4029c32dc09fec3c91b744ee6f61b05db8a5309b8ec
+  metadata.gz: 3e73d11ccd1d49abfb54779069a4a6a802ad21041ce09832221840353a799f358141db46f54e5eccd0416ea3f5ccda7c65c657022a3e6dd0e41ba1fcab91a429
+  data.tar.gz: ec1bf4b5d26f57a95f931f23e98db0288af2883cb27d7bc1447ac4c65ab1052d7a4e9779b947c522e3f4c6a91ae1ca9f2f9a7c6c5ec8c0001c6019d2efa848ad

data/.gitignore

@@ -1,2 +1,3 @@
 .env
 *.gem
+docker-compose.yml

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nano-bots (0.0.1)
+    nano-bots (0.0.2)
       babosa (~> 2.0)
       dotenv (~> 2.8, >= 2.8.1)
       faraday (~> 2.7, >= 2.7.4)

data/README.md

@@ -8,6 +8,7 @@ _Image artificially created by Midjourney through a prompt generated by a Nano B
 https://user-images.githubusercontent.com/113217272/237840989-1e29a5cc-6644-48d0-87b4-62798dc6ebd3.mp4
 
 - [Setup](#setup)
+  - [Docker](#docker)
 - [Usage](#usage)
   - [Command Line](#command-line)
   - [Library](#library)
@@ -20,13 +21,13 @@ https://user-images.githubusercontent.com/113217272/237840989-1e29a5cc-6644-48d0
 For a system usage:
 
 ```sh
-gem install nano-bots -v 0.0.1
+gem install nano-bots -v 0.0.2
 ```
 
 To use it in a project, add it to your `Gemfile`:
 
 ```ruby
-gem 'nano-bots', '~> 0.0.1'
+gem 'nano-bots', '~> 0.0.2'
 ```
 
 ```sh
@@ -46,29 +47,66 @@ export NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridg
 
 Alternatively, if your current directory has a `.env` file with the environment variables, they will be automatically loaded.
 
+## Docker
+
+Clone the repository and copy the Docker Compose template:
+
+```
+git clone git@github.com:icebaker/ruby-nano-bots.git
+cd ruby-nano-bots
+cp docker-compose.example.yml docker-compose.yml
+```
+
+Set your provider credentials and choose your desired directory for the cartridges files:
+
+```yaml
+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"
+    environment:
+      OPENAI_API_ADDRESS: https://api.openai.com
+      OPENAI_API_ACCESS_TOKEN: your-token
+      OPENAI_API_USER_IDENTIFIER: your-user
+    volumes:
+      - ./your-cartridges:/cartridges
+```
+
+Enter the container:
+```sh
+docker compose run nano-bots
+```
+
+Start playing:
+```sh
+nb cartridges/assistant.yml - repl
+```
+
 ## Usage
 
 ### Command Line
 
-After installing the gem, the `rnb` binary command will be available for your project or system.
+After installing the gem, the `nb` binary command will be available for your project or system.
 
 Examples of usage:
 
 ```bash
-rnb to-en-us-translator.yml - eval "Salut, comment ça va?"
+nb to-en-us-translator.yml - eval "Salut, comment ça va?"
 # => Hello, how are you doing?
 
-rnb midjourney.yml - eval "happy and friendly cyberpunk robot"
-# => The robot exploring a bustling city, surrounded by neon lights
-#    and high-rise buildings. The prompt should include colorful
-#    lighting and a sense of excitement in the facial expression.
+nb midjourney.yml - eval "happy cyberpunk robot"
+# => A cheerful and fun-loving robot is dancing wildly amidst a
+#    futuristic and lively cityscape. Holographic advertisements
+#    and vibrant neon colors can be seen in the background.
 
-rnb lisp.yml - eval "(+ 1 2)"
+nb lisp.yml - eval "(+ 1 2)"
 # => 3
 
 cat article.txt |
-  rnb to-en-us-translator.yml - eval |
-  rnb summarizer.yml - eval
+  nb to-en-us-translator.yml - eval |
+  nb summarizer.yml - eval
 # -> LLM stands for Large Language Model, which refers to an
 #    artificial intelligence algorithm capable of processing
 #    and understanding vast amounts of natural language data,
@@ -77,23 +115,34 @@ cat article.txt |
 ```
 
 ```bash
-rnb assistant.yml - repl
+nb assistant.yml - repl
 ```
 
-All of the commands above are stateless. If you want to preserve the history of your interactions, replace the `-` with a state key. You can use a simple key, such as your username, or a randomly generated one:
+```text
+🤖> Hi, how are you doing?
 
-```ruby
-require 'securerandom'
+As an AI language model, I do not experience emotions but I am functioning
+well. How can I assist you?
 
-SecureRandom.hex # => 6ea6c43c42a1c076b1e3c36fa349ac2c
+🤖> |
 ```
 
+All of the commands above are stateless. If you want to preserve the history of your interactions, replace the `-` with a state key:
+
 ```bash
-rnb assistant.yml your-user eval "Salut, comment ça va?"
-rnb assistant.yml your-user repl
+nb assistant.yml your-user eval "Salut, comment ça va?"
+nb assistant.yml your-user repl
 
-rnb assistant.yml 6ea6c43c42a1c076b1e3c36fa349ac2c eval "Salut, comment ça va?"
-rnb assistant.yml 6ea6c43c42a1c076b1e3c36fa349ac2c repl
+nb assistant.yml 6ea6c43c42a1c076b1e3c36fa349ac2c eval "Salut, comment ça va?"
+nb assistant.yml 6ea6c43c42a1c076b1e3c36fa349ac2c repl
+```
+
+You can use a simple key, such as your username, or a randomly generated one:
+
+```ruby
+require 'securerandom'
+
+SecureRandom.hex # => 6ea6c43c42a1c076b1e3c36fa349ac2c
 ```
 
 ### Library
@@ -101,13 +150,13 @@ rnb assistant.yml 6ea6c43c42a1c076b1e3c36fa349ac2c repl
 To use it as a library:
 
 ```ruby
-require 'nano-bots/cli' # Equivalent to the `rnb` command.
+require 'nano-bots/cli' # Equivalent to the `nb` command.
 ```
 
 ```ruby
 require 'nano-bots'
 
-NanoBot.cli # Equivalent to the `rnb` command.
+NanoBot.cli # Equivalent to the `nb` command.
 
 NanoBot.repl(cartridge: 'cartridge.yml') # Starts a new REPL.
 
@@ -128,20 +177,15 @@ Here's what a Nano Bot Cartridge looks like:
 
 ```yaml
 ---
-name: Assistant
-version: 0.0.1
+meta:
+  name: Nano Bot Name
+  author: Your Name
+  version: 0.0.1
 
 behaviors:
   interaction:
     directive: You are a helpful assistant.
 
-interfaces:
-  repl:
-    prompt:
-      - text: '🤖'
-      - text: '> '
-        color: blue
-
 provider:
   name: openai
   settings:
@@ -169,5 +213,5 @@ gem build nano-bots.gemspec
 
 gem signin
 
-gem push nano-bots-0.0.1.gem
+gem push nano-bots-0.0.2.gem
 ```

data/components/providers/openai.rb

@@ -24,6 +24,13 @@ module NanoBot
           )
         end
 
+        def stream(input)
+          provider = @settings.key?(:stream) ? @settings[:stream] : true
+          interface = input[:interface].key?(:stream) ? input[:interface][:stream] : true
+
+          provider && interface
+        end
+
         def evaluate(input, &block)
           messages = input[:history].map do |event|
             { role: event[:who] == 'user' ? 'user' : 'assistant',
@@ -51,7 +58,7 @@ module NanoBot
 
           payload.delete(:logit_bias) if payload.key?(:logit_bias) && payload[:logit_bias].nil?
 
-          if @settings[:stream] && input[:interface][:stream]
+          if stream(input)
             content = ''
 
             payload[:stream] = proc do |chunk, _bytesize|

data/components/storage.rb

@@ -17,8 +17,9 @@ module NanoBot
 
         path = "#{user_home!.sub(%r{/$}, '')}/.local/state/nano-bots" if path.nil?
 
-        path = "#{path.sub(%r{/$}, '')}/nano-bots-rb/#{cartridge[:name].to_slug.normalize}"
-        path = "#{path}/#{cartridge[:version].to_slug.normalize}/#{key.to_slug.normalize}"
+        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}/state.json"
 
         FileUtils.mkdir_p(File.dirname(path))

data/controllers/instance.rb

@@ -6,6 +6,7 @@ require_relative '../logic/helpers/hash'
 require_relative '../components/provider'
 require_relative '../components/storage'
 require_relative './interfaces/repl'
+require_relative './interfaces/eval'
 require_relative './session'
 
 module NanoBot
@@ -24,7 +25,7 @@ module NanoBot
       end
 
       def eval(input)
-        @session.evaluate_and_print(input, mode: 'eval')
+        Interfaces::Eval.evaluate(input, @cartridge, @session)
       end
 
       def repl

data/controllers/interfaces/cli.rb

@@ -13,14 +13,14 @@ module NanoBot
             puts NanoBot::GEM[:version]
             exit
           when 'help', '', nil
-            puts "Ruby Nano Bots #{NanoBot::GEM[:version]}"
-            puts '  rnb cartridge.yml - eval "Hello"'
-            puts '  rnb cartridge.yml - repl'
-            puts '  rnb cartridge.yml - debug'
-            puts '  rnb cartridge.yml STATE-KEY eval "Hello"'
-            puts '  rnb cartridge.yml STATE-KEY repl'
-            puts '  rnb cartridge.yml STATE-KEY debug'
-            puts '  rnb version'
+            puts "Nano Bots #{NanoBot::GEM[:version]}"
+            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 '  nb cartridge.yml STATE-KEY repl'
+            puts '  nb cartridge.yml STATE-KEY debug'
+            puts '  nb version'
             exit
           end
 

data/controllers/interfaces/eval.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'pry'
+require 'rainbow'
+
+require_relative '../../logic/helpers/hash'
+
+module NanoBot
+  module Controllers
+    module Interfaces
+      module Eval
+        def self.evaluate(input, cartridge, session)
+          prefix = build_prefix(cartridge)
+          postfix = build_postfix(cartridge)
+
+          session.print(prefix) unless prefix.nil?
+
+          session.evaluate_and_print(input, mode: 'eval')
+
+          session.print(postfix) unless postfix.nil?
+        end
+
+        def self.build_prefix(cartridge)
+          eval_interface = Logic::Helpers::Hash.fetch(cartridge, %i[interfaces eval])
+          return nil if eval_interface.nil?
+
+          eval_interface[:prefix]
+        end
+
+        def self.build_postfix(cartridge)
+          eval_interface = Logic::Helpers::Hash.fetch(cartridge, %i[interfaces eval])
+          return "\n" if eval_interface.nil? || !eval_interface.key?(:postfix) # default
+
+          eval_interface[:postfix]
+        end
+      end
+    end
+  end
+end

data/controllers/interfaces/repl.rb

@@ -10,20 +10,17 @@ module NanoBot
     module Interfaces
       module REPL
         def self.start(cartridge, session)
-          if Logic::Helpers::Hash.fetch(
-            cartridge, %i[interfaces repl prefix]
-          )
-            session.print(Logic::Helpers::Hash.fetch(cartridge,
-                                                     %i[interfaces repl prefix]))
-          end
-
-          session.boot(mode: 'repl')
-
-          session.print(Logic::Helpers::Hash.fetch(cartridge, %i[interfaces repl postfix]) || "\n")
+          prefix = build_prefix(cartridge)
+          postfix = build_postfix(cartridge)
 
-          session.flush
+          if Logic::Helpers::Hash.fetch(cartridge, %i[behaviors boot instruction])
+            session.print(prefix) unless prefix.nil?
+            session.boot(mode: 'repl')
+            session.print(postfix) unless postfix.nil?
+            session.print("\n")
+          end
 
-          prompt = build_prompt(cartridge[:interfaces][:repl][:prompt])
+          prompt = build_prompt(Logic::Helpers::Hash.fetch(cartridge, %i[interfaces repl prompt]))
 
           Pry.config.prompt = Pry::Prompt.new(
             'REPL',
@@ -32,31 +29,45 @@ module NanoBot
           )
 
           Pry.commands.block_command(/(.*)/, 'handler') do |line|
-            if Logic::Helpers::Hash.fetch(
-              cartridge, %i[interfaces repl prefix]
-            )
-              session.print(Logic::Helpers::Hash.fetch(
-                              cartridge, %i[interfaces repl prefix]
-                            ))
-            end
-
+            session.print(postfix) unless postfix.nil?
             session.evaluate_and_print(line, mode: 'repl')
-            session.print(Logic::Helpers::Hash.fetch(cartridge, %i[interfaces repl postfix]) || "\n")
+            session.print(postfix) unless postfix.nil?
+            session.print("\n")
             session.flush
           end
 
           Pry.start
         end
 
+        def self.build_prefix(cartridge)
+          repl = Logic::Helpers::Hash.fetch(cartridge, %i[interfaces repl])
+          return "\n" if repl.nil? || !repl.key?(:prefix) # default
+
+          repl[:prefix]
+        end
+
+        def self.build_postfix(cartridge)
+          repl = Logic::Helpers::Hash.fetch(cartridge, %i[interfaces repl])
+          return "\n" if repl.nil? || !repl.key?(:postfix) # default
+
+          repl[:postfix]
+        end
+
         def self.build_prompt(prompt)
           result = ''
 
-          prompt.each do |partial|
-            result += if partial[:color]
-                        Rainbow(partial[:text]).send(partial[:color])
-                      else
-                        partial[:text]
-                      end
+          if prompt.is_a?(Array)
+            prompt.each do |partial|
+              result += if partial[:color]
+                          Rainbow(partial[:text]).send(partial[:color])
+                        else
+                          partial[:text]
+                        end
+            end
+          elsif prompt.is_a?(String)
+            result = prompt
+          else
+            result = "🤖#{Rainbow('> ').blue}"
           end
 
           result

data/controllers/session.rb

@@ -67,13 +67,18 @@ module NanoBot
         process(input, mode:)
       end
 
-      def process(input, mode:)
-        streaming = @provider.settings[:stream] && Logic::Helpers::Hash.fetch(
-          @cartridge, [:interfaces, mode.to_sym, :stream]
-        )
+      def stream(interface)
+        provider = @provider.settings.key?(:stream) ? @provider.settings[:stream] : true
+        interface = interface.key?(:stream) ? interface[:stream] : true
+
+        provider && interface
+      end
 
+      def process(input, mode:)
         interface = Logic::Helpers::Hash.fetch(@cartridge, [:interfaces, mode.to_sym]) || {}
 
+        streaming = stream(interface)
+
         input[:interface] = interface
 
         updated_at = Time.now
@@ -84,9 +89,6 @@ module NanoBot
           if finished
             @state[:history] << output
             self.print(output[:message]) unless streaming
-            unless Logic::Helpers::Hash.fetch(@cartridge, [:interfaces, mode.to_sym, :postfix]).nil?
-              self.print(Logic::Helpers::Hash.fetch(@cartridge, [:interfaces, mode.to_sym, :postfix]))
-            end
             ready = true
             flush
           elsif streaming

data/docker-compose.example.yml

@@ -0,0 +1,12 @@
+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"
+    environment:
+      OPENAI_API_ADDRESS: https://api.openai.com
+      OPENAI_API_ACCESS_TOKEN: your-token
+      OPENAI_API_USER_IDENTIFIER: your-user
+    volumes:
+      - ./your-cartridges:/cartridges

data/nano-bots.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['ports/dsl']
 
-  spec.executables = ['rnb']
+  spec.executables = ['nb']
 
   spec.add_dependency 'babosa', '~> 2.0'
   spec.add_dependency 'dotenv', '~> 2.8', '>= 2.8.1'

data/static/gem.rb

@@ -3,7 +3,7 @@
 module NanoBot
   GEM = {
     name: 'nano-bots',
-    version: '0.0.1',
+    version: '0.0.2',
     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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nano-bots
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - icebaker
@@ -117,7 +117,7 @@ description: 'Ruby Implementation of Nano Bots: small, AI-powered bots easily sh
   ChatGPT, Google PaLM, Alpaca, and LLaMA.'
 email: 
 executables:
-- rnb
+- nb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -128,15 +128,17 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
-- bin/rnb
+- bin/nb
 - components/provider.rb
 - components/providers/base.rb
 - components/providers/openai.rb
 - components/storage.rb
 - controllers/instance.rb
 - controllers/interfaces/cli.rb
+- controllers/interfaces/eval.rb
 - controllers/interfaces/repl.rb
 - controllers/session.rb
+- docker-compose.example.yml
 - logic/helpers/hash.rb
 - nano-bots.gemspec
 - ports/dsl/nano-bots.rb