sublayer 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05adf0abb1924f82c0e60a66265331c2b9cfead17a39114fc0dd9c395e5e00ff
-  data.tar.gz: 20a1dfdfbdec1bb59356736150dfc48e623838fc8807e13e743a08205a8d6105
+  metadata.gz: 7a49a0cdd72c4a8171f246646ac8021f72bcdf35a0591931614cbbf7599c3bad
+  data.tar.gz: 3e0da0784fc6ace719556110c47a4145acb01d11ff90555bc25fd7ecb7c6f43f
 SHA512:
-  metadata.gz: 9bc8be69c42f61099bd35163d7b15661cee6244fd5d26a7b1ca0d2cb6b4932c08ed57721a88def4ba2168a27d04080242c19d3c5282d0d9724826de4c1fc9a77
-  data.tar.gz: 7b3e0f0948534ac8313568d8318db2fac51a60467fb8d879d648bccd900ca67ff1dcb7757330f9c5348e69ce463e4376684959d154007365095abd290eea9cda
+  metadata.gz: 9fc567c2e6f84886b525ccac9a842b16e6e519b17d46d6eb86cec502eeafb29c110936ad8a11978124b478f8a3271415c8f96473aaebbd3d28f4678a8736340f
+  data.tar.gz: 17a53b8f40146f09f2380f4c25ad86526d6b78dac8562ab1a06f047ab05e16646cdac4bc1453533f313e6c9bdb5a6e1537a7f8efb2ab515286608eec990ee26e

data/README.md

@@ -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

data/lib/sublayer/agents/base.rb

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

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.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sublayer
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Scott Werner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-08 00:00:00.000000000 Z
+date: 2024-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -153,6 +153,7 @@ files:
 - 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
@@ -161,6 +162,7 @@ files:
 - 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