roseflow-tiktoken 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f3b272bb8e3b5a4805fe59670894340347a0310ada891f29abb03235b4aca243
+  data.tar.gz: 3135181d05c8ee397d57d88f99f100f8db45dc5cd7295dff27db3641de7bcc0f
+SHA512:
+  metadata.gz: a21a9d867e21ea71d36f1605e894fd68933088c25df3077381bdecd1d20b7d12e13826577fe649832dc9294d6aa9e14ade0591cdf2327fe1883d60233005d342
+  data.tar.gz: 6f94d37d4f661d5d672e8a5c8a9952544458d815f7997ecd01db82f6e2b17cbb8d3a9b7838993b5567e883d744abb08cf3f51a38030437b5823a79bf7ee0c8ff

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-02
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,7 @@
+# Contributor Code of Conduct
+
+The Roseflow team is committed to fostering a welcoming community.
+
+**Our Code of Conduct can be found here**:
+
+https://roseflow.ai/conduct

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in roseflow-tiktoken.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Lauri Jutila
+
+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,78 @@
+# Tiktoken tokenizer for Roseflow
+
+[tiktoken](https://github.com/openai/tiktoken) is a fast BPE tokenizer for use with OpenAI's models. `roseflow-tiktoken` gem helps you use the tokenizer in Ruby, especially with (Roseflow)[https://github.com/ljuti/roseflow].
+
+Currently, this gem wraps the (`tiktoken` Python module)[https://github.com/openai/tiktoken] for convenient use in Roseflow.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+$ bundle add roseflow-tiktoken
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+$ gem install roseflow-tiktoken
+```
+
+## Usage
+
+Encode with tokenizer.
+
+```ruby
+tokenizer = Roseflow::Tiktoken::Tokenizer.new(model: "gpt-3.5-turbo")
+tokenizer.encode("Turn this string into tokens.") # => [...] array of tokens
+```
+
+Decode with tokenizer.
+
+```ruby
+tokenizer = Roseflow::Tiktoken::Tokenizer.new(model: "gpt-3.5-turbo")
+tokenizer.decode([19952, 420, 925, 1139, 11460, 13]) # => "Turn this string into tokens.")
+```
+
+### Encodings
+
+`roseflow-tiktoken` supports these encodings used by OpenAI models:
+
+| Encoding name           | OpenAI models                                                             |
+| ----------------------- | ------------------------------------------------------------------------- |
+| `cl100k_base`           | ChatGPT models, `text-embedding-ada-002`                                  |
+| `p50k_base`             | Code models, `text-davinci-002`, `text-davinci-003`                       |
+| `p50k_edit`             | Use for edit models like `text-davinci-edit-001`, `code-davinci-edit-001` |
+| `r50k_base` (or `gpt2`) | GPT-3 models like `davinci`                                               |
+
+## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/roseflow-ai/roseflow-tiktoken.
+
+## Community
+
+### Discord
+
+Join us in our [Discord](https://discord.gg/roseflow).
+
+### Twitter
+
+Connect with the core team on Twitter.
+
+<a href="https://twitter.com/ljuti" target="_blank">
+  <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/ljuti?logo=twitter&style=social">
+</a>
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the `roseflow-tiktoken` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/roseflow-ai/roseflow-tiktoken/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/roseflow/tiktoken/tokenizer.rb

@@ -0,0 +1,75 @@
+require "pycall"
+
+module Roseflow
+  module Tiktoken
+    class Tokenizer
+      def initialize(model: nil)
+        @tokenizer = PyCall.import_module("tiktoken")
+        @model = model
+        @encoding = @tokenizer.encoding_for_model(@model) if @model
+      end
+
+      def encode(input)
+        @encoding.encode(input)
+      rescue
+        raise ::Roseflow::Tiktoken::NoEncodingError, "No encoding found for model #{@model}"
+      end
+
+      def decode(input)
+        @encoding.decode(input)
+      rescue
+        raise ::Roseflow::Tiktoken::NoEncodingError, "No encoding found for model #{@model}"
+      end
+
+      def count_tokens(messages)
+        token_count = 0
+
+        messages.each do |message|
+          token_count += tokens_per_message_for_model(@model)
+
+          message.each do |key, value|
+            token_count += encode(value).count
+            if key == "name"
+              token_count += tokens_per_message_for_model(@model)
+            end
+          end
+        end
+
+        token_count += 3 # Every reply is primed with assistant
+        return token_count
+      end
+
+      private
+
+      def tokens_per_message_for_model(model)
+        case model
+        when "gpt-4"
+          tokens_per_message_for_model("gpt-4-0314")
+        when "gpt-3.5-turbo"
+          tokens_per_message_for_model("gpt-3.5-turbo-0301")
+        when "gpt-4-0314"
+          3
+        when "gpt-3.5-turbo-0301"
+          4
+        else
+          raise NotImplementedError, "Model #{model} is not supported."
+        end
+      end
+
+      def tokens_per_name_for_model(model)
+        case model
+        when "gpt-4"
+          tokens_per_message_for_model("gpt-4-0314")
+        when "gpt-3.5-turbo"
+          tokens_per_message_for_model("gpt-3.5-turbo-0301")
+        when "gpt-4-0314"
+          1
+        when "gpt-3.5-turbo-0301"
+          -1
+        else
+          raise NotImplementedError, "Model #{model} is not supported."
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/tiktoken/version.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Roseflow
+  module Tiktoken
+    def self.gem_version
+      Gem::Version.new VERSION::STRING
+    end
+
+    module VERSION
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+      PRE = nil
+
+      STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
+    end
+  end
+end

data/lib/roseflow/tiktoken.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "tiktoken/version"
+require "roseflow/tiktoken/tokenizer"
+
+module Roseflow
+  module Tiktoken
+    class Error < StandardError; end
+    class NoEncodingError < StandardError; end
+  end
+end

data/roseflow-tiktoken.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/roseflow/tiktoken/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "roseflow-tiktoken"
+  spec.version = Roseflow::Tiktoken.gem_version
+  spec.authors = ["Lauri Jutila"]
+  spec.email = ["git@laurijutila.com"]
+
+  spec.summary = "Tiktoken tokenizer for Roseflow."
+  spec.description = "Tiktoken tokenizer for Roseflow."
+  spec.homepage = "https://github.com/roseflow-ai/roseflow-tiktoken"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/roseflow-ai/roseflow-tiktoken"
+  spec.metadata["changelog_uri"] = "https://github.com/roseflow-ai/roseflow-tiktoken/blob/master/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 "pycall", "~> 1.4"
+end

data/sig/roseflow/tiktoken.rbs

@@ -0,0 +1,6 @@
+module Roseflow
+  module Tiktoken
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: roseflow-tiktoken
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lauri Jutila
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pycall
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Tiktoken tokenizer for Roseflow.
+email:
+- git@laurijutila.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/roseflow/tiktoken.rb
+- lib/roseflow/tiktoken/tokenizer.rb
+- lib/roseflow/tiktoken/version.rb
+- roseflow-tiktoken.gemspec
+- sig/roseflow/tiktoken.rbs
+homepage: https://github.com/roseflow-ai/roseflow-tiktoken
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/roseflow-ai/roseflow-tiktoken
+  source_code_uri: https://github.com/roseflow-ai/roseflow-tiktoken
+  changelog_uri: https://github.com/roseflow-ai/roseflow-tiktoken/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Tiktoken tokenizer for Roseflow.
+test_files: []