gpt4all 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f611f3c03de174c0bbc7ff1cf009569c8f2b4405cb4cead51fdafc367559fcd9
+  data.tar.gz: 376a1e7c1100b5368d4fd6a00ad7226c7b9def1510aae6fb7af2b3629d3fe860
+SHA512:
+  metadata.gz: 8be39a0889515dd33171fb73db9905edde1f8f68872b389268ec19a3352761202a3da2f524d3a18a777d8f5b032f151ed9e62656655d736e83ad4bce357f2a17
+  data.tar.gz: 03e6ea52397c7426081333ec3b36f4d274e2df259f55afdd2eea0dc376f1df7ae7e1781afd03a58223a88ea8c8c35156fed5e5b37bbe5d328cf35eeb7ae4e571

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,30 @@
+require:
+  - rubocop-performance
+  - rubocop-sequel
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+  Exclude:
+    - db/**/*.rb
+    - bin/**/*.rb
+    - bin/*
+    - vendor/**/*
+    - coverage/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/support/shared_contexts/*.rb
+    - spec/support/shared_examples/*.rb
+    - spec/**/*_spec.rb
+    - spec/factories/*.rb
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/RescueModifier:
+  Exclude:
+    - spec/**/*_spec.rb

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2023-04-07
+
+- Initial release

data/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gpt4all.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'
+
+gem 'brakeman'
+gem 'bundler-audit'
+gem 'byebug'
+gem 'dotenv'
+gem 'license_finder'
+gem 'overcommit'
+gem 'rubocop-performance'
+gem 'rubocop-sequel'
+gem 'rubocop-shopify'
+
+gem 'webmock', require: false

data/Gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: .
+  specs:
+    gpt4all (0.0.1)
+      faraday (~> 2.7)
+      os (~> 1.1)
+      tty-progressbar (~> 0.18.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.3)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    brakeman (5.4.1)
+    bundler-audit (0.9.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    byebug (11.1.3)
+    childprocess (4.1.0)
+    crack (0.4.5)
+      rexml
+    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-net_http (3.0.2)
+    hashdiff (1.0.1)
+    iniparse (1.5.0)
+    json (2.6.3)
+    license_finder (7.1.0)
+      bundler
+      rubyzip (>= 1, < 3)
+      thor (~> 1.2)
+      tomlrb (>= 1.3, < 2.1)
+      with_env (= 1.1.0)
+      xml-simple (~> 1.1.9)
+    os (1.1.4)
+    overcommit (0.60.0)
+      childprocess (>= 0.6.3, < 5)
+      iniparse (~> 1.4)
+      rexml (~> 3.2)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.49.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-sequel (0.3.4)
+      rubocop (~> 1.0)
+    rubocop-shopify (2.12.0)
+      rubocop (~> 1.44)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    rubyzip (2.3.2)
+    strings-ansi (0.2.0)
+    thor (1.2.1)
+    tomlrb (2.0.3)
+    tty-cursor (0.7.1)
+    tty-progressbar (0.18.2)
+      strings-ansi (~> 0.2)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      unicode-display_width (>= 1.6, < 3.0)
+    tty-screen (0.8.1)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    with_env (1.1.0)
+    xml-simple (1.1.9)
+      rexml
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  brakeman
+  bundler-audit
+  byebug
+  dotenv
+  gpt4all!
+  license_finder
+  overcommit
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-performance
+  rubocop-sequel
+  rubocop-shopify
+  webmock
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Jaigouk Kim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Gpt4all
+
+Gpt4all is a Ruby gem that provides an easy-to-use interface for interacting with the GPT-4 conversational AI model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gpt4all'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+Or install it yourself as:
+
+```bash
+$ gem install gpt4all
+```
+
+## Usage
+
+To use the Gpt4all gem, you can follow these steps:
+
+```ruby
+require 'gpt4all'
+
+gpt4all = Gpt4all::ConversationalAI.new
+gpt4all.prepare_resources(force_download: true)
+gpt4all.start_bot
+
+response = gpt4all.prompt('What is your name?')
+puts response
+
+gpt4all.stop_bot
+```
+
+## Development
+
+After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/gpt4all.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gpt4all/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'gpt4all'
+  spec.version = Gpt4all::VERSION
+  spec.authors = ['Jaigouk Kim']
+  spec.email = ['ping@jaigouk.kim']
+
+  spec.summary = 'gpt4all'
+  spec.description = 'interface to gpt4all'
+  spec.homepage = 'https://github.com/jaigouk/gpt4all'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.2'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/jaigouk/gpt4all'
+  spec.metadata['changelog_uri'] = 'https://github.com/jaigouk/gpt4all/CHANGELOG.md'
+
+  # 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.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 2.7'
+  spec.add_dependency 'os', '~> 1.1'
+  spec.add_dependency 'tty-progressbar', '~> 0.18.2'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/gpt4all/conversational_ai.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'open3'
+require 'os'
+require 'faraday'
+require 'tty-progressbar'
+
+module Gpt4all
+  # rubocop:disable Metrics/ClassLength
+  class ConversationalAI
+    attr_accessor :bot, :model, :decoder_config, :executable_path, :model_path, :force_download, :test_mode
+
+    OSX_INTEL_URL = 'https://github.com/nomic-ai/gpt4all/blob/main/chat/gpt4all-lora-quantized-OSX-intel?raw=true'
+    OSX_M1_URL = 'https://github.com/nomic-ai/gpt4all/blob/main/chat/gpt4all-lora-quantized-OSX-m1?raw=true'
+    LINUX_URL = 'https://github.com/nomic-ai/gpt4all/blob/main/chat/gpt4all-lora-quantized-linux-x86?raw=true'
+    WINDOWS_URL = 'https://github.com/nomic-ai/gpt4all/blob/main/chat/gpt4all-lora-quantized-win64.exe?raw=true'
+
+    # rubocop:disable Metrics/MethodLength
+    def initialize(model: 'gpt4all-lora-quantized', force_download: false, decoder_config: {})
+      @bot = nil
+      @model = model
+      @decoder_config = decoder_config
+      @executable_path = "#{Dir.home}/.nomic/gpt4all"
+      @model_path = "#{Dir.home}/.nomic/#{model}.bin"
+      @force_download = force_download
+      @test_mode = false
+
+      return unless %w[gpt4all-lora-quantized gpt4all-lora-unfiltered-quantized].none?(model)
+
+      raise "Model #{model} is not supported. Current models supported are:
+                  gpt4all-lora-quantized
+                  gpt4all-lora-unfiltered-quantized"
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def prepare_resources(force_download: false)
+      download_promises = []
+
+      download_promises << download_executable if force_download || !File.exist?(executable_path)
+      download_promises << download_model if force_download || !File.exist?(model_path)
+
+      download_promises.compact.each(&:call)
+    end
+
+    def start_bot
+      stop_bot if bot
+
+      spawn_args = [executable_path, '--model', model_path]
+
+      decoder_config.each do |key, value|
+        spawn_args.push("--#{key}", value.to_s)
+      end
+
+      @bot = Open3.popen2e(*spawn_args)
+      @bot_pid = bot.last.pid
+
+      wait_for_bot_ready
+    end
+
+    def stop_bot
+      return unless bot
+
+      bot.each(&:close)
+      @bot = nil
+      @bot_pid = nil
+    end
+
+    def download_executable
+      upstream = determine_upstream_url
+      download_file(upstream, executable_path)
+      FileUtils.chmod(0o755, executable_path)
+      puts "File downloaded successfully to #{executable_path}"
+    end
+
+    def determine_upstream_url
+      if OS.mac?
+        OS.host_cpu == 'x86_64' ? OSX_INTEL_URL : OSX_M1_URL
+      elsif OS.linux?
+        LINUX_URL
+      elsif OS.windows?
+        WINDOWS_URL
+      else
+        raise 'Unsupported platform. Supported: OSX (ARM and Intel), Linux, Windows.'
+      end
+    end
+
+    def download_model
+      model_url = "https://the-eye.eu/public/AI/models/nomic-ai/gpt4all/#{model}.bin"
+
+      download_file(model_url, model_path)
+
+      puts "File downloaded successfully to #{model_path}"
+    end
+
+    def download_file(url, destination)
+      response = create_faraday_connection(url)
+      total_size = response.headers['Content-Length'].to_i
+      create_destination_directory(destination)
+      download_with_progress_bar(response, destination, total_size)
+      puts "File downloaded successfully to #{destination}"
+    end
+
+    def create_faraday_connection(url)
+      connection = Faraday.new(url) do |f|
+        f.response :raise_error
+        f.adapter Faraday.default_adapter
+      end
+
+      connection.get do |request|
+        request.headers['Accept-Encoding'] = 'identity'
+      end
+    end
+
+    def create_destination_directory(destination)
+      FileUtils.mkdir_p(File.dirname(destination))
+    end
+
+    def download_with_progress_bar(response, destination, total_size)
+      progress_bar = TTY::ProgressBar.new(
+        '[:bar] :percent :etas',
+        complete: '=',
+        incomplete: ' ',
+        width: 20,
+        total: total_size
+      )
+
+      write_chunks_to_file(response, destination, progress_bar)
+    end
+
+    def write_chunks_to_file(response, destination, progress_bar)
+      File.open(destination, 'wb') do |file|
+        response.body.each_chunk do |chunk|
+          progress_bar.advance(chunk.bytesize)
+          file.write(chunk)
+        end
+      end
+    end
+
+    def wait_for_bot_ready
+      loop do
+        output = bot.last.gets
+        break if output&.include?('>')
+      end
+    end
+
+    def prompt(input)
+      ensure_bot_is_ready
+
+      begin
+        bot.first.puts(input)
+        response = bot.last.gets.strip
+      rescue StandardError => e
+        puts "Error during prompt: #{e.message}"
+        restart_bot
+        response = prompt(input)
+      end
+
+      response
+    end
+
+    def ensure_bot_is_ready
+      raise 'Bot is not initialized.' unless bot
+    end
+
+    def restart_bot
+      stop_bot
+      start_bot
+    end
+  end
+  # rubocop:enable Metrics/ClassLength
+end

data/lib/gpt4all/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gpt4all
+  VERSION = '0.0.1'
+end

data/lib/gpt4all.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'gpt4all/version'
+require_relative 'gpt4all/conversational_ai'
+
+module Gpt4all
+  class Error < StandardError; end
+end

data/sig/gpt4all.rbs

@@ -0,0 +1,27 @@
+module Gpt4all
+  VERSION: String
+
+  class ConversationalAI
+    @bot: Process::Child | nil
+    @model: String
+    @decoder_config: Hash[String, untyped]
+    @executable_path: String
+    @model_path: String
+
+    def initialize: (String? model, bool? force_download, Hash[String, untyped]? decoder_config) -> void
+
+    def init: (?bool force_download) -> void
+
+    def open: () -> void
+
+    def close: () -> void
+
+    private def download_executable: () -> void
+
+    private def download_model: () -> void
+
+    private def download_file: (String url, String destination) -> void
+
+    def prompt: (String input) -> String
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: gpt4all
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jaigouk Kim
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+description: interface to gpt4all
+email:
+- ping@jaigouk.kim
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- gpt4all.gemspec
+- lib/gpt4all.rb
+- lib/gpt4all/conversational_ai.rb
+- lib/gpt4all/version.rb
+- sig/gpt4all.rbs
+homepage: https://github.com/jaigouk/gpt4all
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/jaigouk/gpt4all
+  source_code_uri: https://github.com/jaigouk/gpt4all
+  changelog_uri: https://github.com/jaigouk/gpt4all/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: gpt4all
+test_files: []