sublayer 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05adf0abb1924f82c0e60a66265331c2b9cfead17a39114fc0dd9c395e5e00ff
-  data.tar.gz: 20a1dfdfbdec1bb59356736150dfc48e623838fc8807e13e743a08205a8d6105
+  metadata.gz: 07ead9b290805b3d7e173f8e613dd4670bdd304a094cb7a00505ac9d94285b9b
+  data.tar.gz: 89eba4a05eebb012013a68e06f4d44e8a1710db0ea8a808ed03557241f4baf74
 SHA512:
-  metadata.gz: 9bc8be69c42f61099bd35163d7b15661cee6244fd5d26a7b1ca0d2cb6b4932c08ed57721a88def4ba2168a27d04080242c19d3c5282d0d9724826de4c1fc9a77
-  data.tar.gz: 7b3e0f0948534ac8313568d8318db2fac51a60467fb8d879d648bccd900ca67ff1dcb7757330f9c5348e69ce463e4376684959d154007365095abd290eea9cda
+  metadata.gz: a6f07414c4a7a2798f2b93133bd921cae8ffe380104f813564109ab16b985dd58c416f6b176f33d75910898b56d47ea98262a1f1035071cb29dddf2f53277b82
+  data.tar.gz: 45953c8a3a63c526bd310f4928a1570210e54e6e1be5718ff50b28041a8e9e93ca175d8d984ca6abd8aa729b87f5c84bf922e547c6a8f22ef62272bd240eade2

data/README.md

@@ -26,7 +26,7 @@ Sublayer is model-agnostic and can be used with any AI model. Below are the
 
 Expects you to have an OpenAI API key set in the `OPENAI_API_KEY` environment variable.
 
-Visit [OpenAI](https://openai.com/product) to get an API key. 
+Visit [OpenAI](https://openai.com/product) to get an API key.
 
 Usage:
 ```ruby
@@ -71,26 +71,60 @@ Sublayer.configuration.ai_provider = Sublayer::Providers::Groq
 Sublayer.configuration.ai_model = "mixtral-8x7b-32768"
 ```
 
-### Local (Experimental with Hermes2)
+### Local
 
-*Tested against the latest [Hermes 2 Mistral
-Model](https://huggingface.co/NousResearch/Hermes-2-Pro-Mistral-7B-GGUF)*
+If you've never run a local model before see the [Local Model Quickstart](#local-model-quickstart) below. Know that local models take several GB of space.
 
-Support for running a local model and serving an API on https://localhost:8080
+The model you use must have the ChatML formatted v1/chat/completions endpoint to work with sublayer (many models do by default)
 
-The simplest way to do this is to download 
-[llamafile](https://github.com/Mozilla-Ocho/llamafile) and download one of the
-server llamafiles they provide.
-
-We've also tested with [Hermes 2 Mistral](https://huggingface.co/NousResearch/Hermes-2-Pro-Mistral-7B-GGUF) from
-[Nous
-Research](https://nousresearch.com/).
+Usage:
 
+Run your local model on http://localhost:8080 and then set:
 ```ruby
 Sublayer.configuration.ai_provider = Sublayer::Providers::Local
 Sublayer.configuration.ai_model = "LLaMA_CPP"
 ```
 
+#### Local Model Quickstart:
+
+Instructions to run a local model
+
+1. Setting up Llamafile
+
+  ```bash
+  cd where/you/keep/your/projects
+  git clone git@github.com:Mozilla-Ocho/llamafile.git
+  cd llamafile
+  ```
+
+  Download: https://cosmo.zip/pub/cosmos/bin/make (windows users need this too: https://justine.lol/cosmo3/)
+
+  ```bash
+  # within llamafile directory
+  chmod +x path/to/the/downloaded/make
+  path/to/the/downloaded/make -j8
+  sudo path/to/the/downloaded/make install PREFIX=/usr/local
+  ```
+  You can now run llamfile
+
+2. Downloading Model
+
+  click [here](https://huggingface.co/NousResearch/Hermes-2-Pro-Mistral-7B-GGUF/resolve/main/Hermes-2-Pro-Mistral-7B.Q5_K_M.gguf?download=true) to download Mistral_7b.Q5_K_M (5.13 GB)
+
+3. Running Llamafile with a model
+
+  ```bash
+  llamafile -ngl 9999 -m path/to/the/downloaded/Hermes-2-Pro-Mistral-7B.Q5_K_M.gguf --host 0.0.0.0 -c 4096
+  ```
+
+  You are now running a local model on http://localhost:8080
+
+#### Recommended Settings for Apple M1 users:
+```bash
+llamafile -ngl 9999 -m Hermes-2-Pro-Mistral-7B.Q5_K_M.gguf --host 0.0.0.0 --nobrowser -c 2048 --gpu APPLE -t 12
+```
+run `sysctl -n hw.logicalcpu` to see what number to give the `-t` threads option
+
 ## Concepts
 
 ### Generators
@@ -99,12 +133,12 @@ Generators are responsible for generating specific outputs based on input data.
 They focus on a single generation task and do not perform any actions or complex
 decision-making. Generators are the building blocks of the Sublayer framework.
 
-Examples (in the /examples/ directory):
-- CodeFromDescriptionGenerator: Generates code based on a description and the
+Examples (in the `/lib/sublayer/generators/examples` directory):
+- `CodeFromDescriptionGenerator`: Generates code based on a description and the
   technologies used.
-- DescriptionFromCodeGenerator: Generates a description of the code passed in to
+- `DescriptionFromCodeGenerator`: Generates a description of the code passed in to
   it.
-- CodeFromBlueprintGenerator: Generates code based on a blueprint, a blueprint
+- `CodeFromBlueprintGenerator`: Generates code based on a blueprint, a blueprint
   description, and a description of the desired code.
 
 

data/lib/sublayer/agents/base.rb

@@ -0,0 +1,6 @@
+module Sublayer
+  module Agents
+    class Base
+    end
+  end
+end

data/lib/sublayer/components/output_adapters.rb

@@ -4,7 +4,21 @@ module Sublayer
       attr_reader :name
 
       def self.create(options)
-        ("Sublayer::Components::OutputAdapters::"+options[:type].to_s.camelize).constantize.new(options)
+        klass = if options.has_key?(:class)
+          klass = options[:class]
+          if klass.is_a?(String)
+            klass.constantize
+          elsif klass.is_a?(Class)
+            klass
+          else
+            raise "Invalid :class option"
+          end
+        elsif (type = options[:type])
+          "Sublayer::Components::OutputAdapters::#{type.to_s.camelize}".constantize
+        else
+          raise "Output adapter must be specified with :class or :type"
+        end
+        klass.new(options)
       end
     end
   end

data/lib/sublayer/providers/claude.rb

@@ -30,7 +30,7 @@ module Sublayer
         response = HTTParty.post(
           "https://api.anthropic.com/v1/messages",
           headers: {
-            "x-api-key": ENV["ANTHROPIC_API_KEY"],
+            "x-api-key": ENV.fetch("ANTHROPIC_API_KEY"),
             "anthropic-version": "2023-06-01",
             "content-type": "application/json"
           },

data/lib/sublayer/providers/open_ai.rb

@@ -5,7 +5,7 @@ module Sublayer
   module Providers
     class OpenAI
       def self.call(prompt:, output_adapter:)
-        client = ::OpenAI::Client.new(access_token: ENV["OPENAI_API_KEY"])
+        client = ::OpenAI::Client.new(access_token: ENV.fetch("OPENAI_API_KEY"))
 
         response = client.chat(
           parameters: {

data/lib/sublayer/tasks/base.rb

@@ -0,0 +1,6 @@
+module Sublayer
+  module Tasks
+    class Base
+    end
+  end
+end

data/lib/sublayer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sublayer
-  VERSION = "0.0.5"
+  VERSION = "0.0.7"
 end

data/sublayer.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = "https://docs.sublayer.com"
   spec.metadata["documentation_uri"] = "https://docs.sublayer.com"
   spec.metadata["bug_tracker_uri"] = "https://github.com/sublayerapp/sublayer/issues"
+  spec.metadata["source_code_uri"] = "https://github.com/sublayerapp/sublayer"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -37,6 +38,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "httparty"
 
   spec.add_development_dependency "rspec", "~> 3.12"
-  spec.add_development_dependency "pry", " ~> 0.14"
+  spec.add_development_dependency "pry", "~> 0.14"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
   spec.add_development_dependency "clag"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sublayer
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Scott Werner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-08 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -122,6 +122,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: clag
   requirement: !ruby/object:Gem::Requirement
@@ -147,20 +175,22 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- examples/code_from_blueprint_generator.rb
-- examples/code_from_description_generator.rb
-- examples/description_from_code_generator.rb
-- examples/invalid_to_valid_json_generator.rb
 - lib/sublayer.rb
 - lib/sublayer/actions/base.rb
+- lib/sublayer/agents/base.rb
 - lib/sublayer/components/output_adapters.rb
 - lib/sublayer/components/output_adapters/single_string.rb
 - lib/sublayer/generators/base.rb
+- lib/sublayer/generators/examples/code_from_blueprint_generator.rb
+- lib/sublayer/generators/examples/code_from_description_generator.rb
+- lib/sublayer/generators/examples/description_from_code_generator.rb
+- lib/sublayer/generators/examples/invalid_to_valid_json_generator.rb
 - lib/sublayer/providers/claude.rb
 - lib/sublayer/providers/gemini.rb
 - lib/sublayer/providers/groq.rb
 - lib/sublayer/providers/local.rb
 - lib/sublayer/providers/open_ai.rb
+- lib/sublayer/tasks/base.rb
 - lib/sublayer/version.rb
 - sublayer.gemspec
 homepage: https://docs.sublayer.com
@@ -170,6 +200,7 @@ metadata:
   homepage_uri: https://docs.sublayer.com
   documentation_uri: https://docs.sublayer.com
   bug_tracker_uri: https://github.com/sublayerapp/sublayer/issues
+  source_code_uri: https://github.com/sublayerapp/sublayer
 post_install_message:
 rdoc_options: []
 require_paths: