replicate-ruby 0.1.7 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e58708bf432115af17aef8f67789838f4044526a851785a04dd3f206d17f727
-  data.tar.gz: f1422c952891c61df45c4a4bd69e27f13b724185edc883df8dec00addec7679a
+  metadata.gz: '0840bf61f6fc1f27234815e501bc2f68a40e1af9b001c5e0df782d0e4083f2d6'
+  data.tar.gz: bc055f8e4f403c8917e47fd90155ae6e4d4c2216a56f7275ee7e8c8d4d2eabd4
 SHA512:
-  metadata.gz: 234415f451e806a5d2c800cf11da2aa626b131f4c8f5d3df501c317607a5637c267bc757d75115bb8fd5c6378500bd6c38c749c722f7a38ebad4f6bd8b7b5f7d
-  data.tar.gz: ea46776b902acd5cec2283fd8bd390127244771c0250e05623303f1d5284e1aa982240eecd5227b2b2f243d01ccc8d8c099442a33c28f114287b97e9765e26ba
+  metadata.gz: 47250571e1bcafbe1b77238243229665b97e756d4a3eed92f1bbcc2f99addaa23baef4074b49f7bf784711c4b887b6e3c8c21cc019693e5a79b1b7fe6fea778c
+  data.tar.gz: 6e5bc89eeb116c32a81f246d044e782b85a230df7c4d19e3c3ddfb2ac2a54f5c1dc5a7772f3b2101c4a267a55b20f2a1a9e58d7c0a30fa2d950de290179775ec

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    replicate-ruby (0.1.7)
+    replicate-ruby (0.2.1)
       addressable
       faraday (>= 2.0)
+      faraday-multipart
       faraday-retry
 
 GEM
@@ -12,12 +13,15 @@ GEM
     addressable (2.8.1)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    byebug (11.1.3)
     coderay (1.1.3)
     crack (0.4.5)
       rexml
     faraday (2.7.2)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
     faraday-net_http (3.0.2)
     faraday-retry (2.0.0)
       faraday (~> 2.0)
@@ -25,6 +29,7 @@ GEM
     json (2.6.2)
     method_source (1.0.0)
     minitest (5.16.3)
+    multipart-post (2.2.3)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
@@ -57,9 +62,11 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  arm64-darwin-22
   x86_64-darwin-21
 
 DEPENDENCIES
+  byebug
   minitest (~> 5.0)
   pry
   rake (~> 13.0)

data/README.md

@@ -54,6 +54,41 @@ id = prediction.id # store prediction id in your backend
 prediction = Replicate.client.retrieve_prediction(id) # retrieve prediction during webhook with id from backend
 ```
 
+## Dreambooth
+
+There is support for the [experimental dreambooth endpoint](https://replicate.com/blog/dreambooth-api).
+
+First, upload your training dataset:
+
+```ruby
+upload = Replicate.client.upload_zip('tmp/data.zip') # replace with the path to your zip file
+```
+
+Then start training a new model using, for instance:
+
+```ruby
+training = Replicate.client.create_training(
+  input: {
+    instance_prompt: "zwx style",
+    class_prompt: "style",
+    instance_data: upload.serving_url,
+    max_train_steps: 5000
+  },
+  model: 'yourusername/yourmodel'
+)
+```
+
+As soon as the model has finished training, you can run predictions on it:
+
+```ruby
+prediction = Replicate.client.create_prediction(
+  input: {
+    prompt: 'your prompt, zwx style'
+  },
+  version: training.version
+)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/replicate/client/model.rb

@@ -9,20 +9,22 @@ module Replicate
       def retrieve_model(model, version: :latest)
         case version
         when :latest
-          Replicate::Record::Model.new(self, get("models/#{model}"))
+          response = api_endpoint.get("models/#{model}")
+          Replicate::Record::Model.new(self, response)
         when :all
-          response = get("models/#{model}/versions")
+          response = api_endpoint.get("models/#{model}/versions")
           response["results"].map! { |result| Replicate::Record::ModelVersion.new(self, result) }
           response
         else
-          Replicate::Record::ModelVersion.new(self, get("models/#{model}/versions/#{version}"))
+          response = api_endpoint.get("models/#{model}/versions/#{version}")
+          Replicate::Record::ModelVersion.new(self, response)
         end
       end
 
       # Get a collection of models
       # @see https://replicate.com/docs/reference/http#get-collection
       def retrieve_collection(slug)
-        get("collections/#{slug}")
+        api_endpoint.get("collections/#{slug}")
       end
     end
   end

data/lib/replicate/client/prediction.rb

@@ -7,13 +7,14 @@ module Replicate
       # Get a prediction
       # @see https://replicate.com/docs/reference/http#get-prediction
       def retrieve_prediction(id)
-        Replicate::Record::Prediction.new(self, get("predictions/#{id}"))
+        response = api_endpoint.get("predictions/#{id}")
+        Replicate::Record::Prediction.new(self, response)
       end
 
       # Get a list of predictions
       # @see https://replicate.com/docs/reference/http#get-predictions
       def list_predictions(cursor = nil)
-        response = get("predictions", cursor: cursor)
+        response = api_endpoint.get("predictions", cursor: cursor)
         response["results"].map! { |result| Replicate::Record::Prediction.new(self, result) }
         response
       end
@@ -22,13 +23,15 @@ module Replicate
       # @see https://replicate.com/docs/reference/http#create-prediction
       def create_prediction(params)
         params[:webhook_completed] ||= webhook_url
-        Replicate::Record::Prediction.new(self, post("predictions", params))
+        response = api_endpoint.post("predictions", params)
+        Replicate::Record::Prediction.new(self, response)
       end
 
       # Cancel a prediction
       # @see https://replicate.com/docs/reference/http#cancel-prediction
       def cancel_prediction(id)
-        Replicate::Record::Prediction.new(self, post("predictions/#{id}/cancel"))
+        response = api_endpont.post("predictions/#{id}/cancel")
+        Replicate::Record::Prediction.new(self, response)
       end
     end
   end

data/lib/replicate/client/training.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Replicate
+  class Client
+    # Methods for the Prediction API
+    module Training
+      # Get a training
+      # @see https://replicate.com/blog/dreambooth-api
+      def retrieve_training(id)
+        response = dreambooth_endpoint.get("trainings/#{id}")
+        Replicate::Record::Training.new(self, response)
+      end
+
+      # Create a training
+      # @see https://replicate.com/blog/dreambooth-api
+      def create_training(params)
+        params[:webhook_completed] ||= webhook_url
+        response = dreambooth_endpoint.post("trainings", params)
+        Replicate::Record::Training.new(self, response)
+      end
+    end
+  end
+end

data/lib/replicate/client/upload.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Replicate
+  class Client
+    # Methods for the Prediction API
+    module Upload
+      # Create upload object and upload zip file
+      def upload_zip(zip_path)
+        filename = zip_path.split('/')[-1]
+        upload = create_upload(filename)
+        upload.attach(zip_path)
+        upload
+      end
+
+      # Create an upload
+      # @see https://replicate.com/blog/dreambooth-api
+      def create_upload(filename = 'data.zip')
+        response = dreambooth_endpoint.post("upload/#{filename}")
+        Replicate::Record::Upload.new(self, response)
+      end
+
+      # Create an upload
+      # @see https://replicate.com/blog/dreambooth-api
+      def update_upload(upload_endpoint_url, zip_path)
+        endpoint = Replicate::Endpoint.new(endpoint_url: upload_endpoint_url, api_token: nil)
+        endpoint.agent.put do |req|
+          req.headers["Content-Type"] = "application/zip"
+          req.headers["Content-Length"] = File.size(zip_path).to_s
+          req.headers["Transfer-Encoding"] = "chunked"
+          req.body = Faraday::UploadIO.new(zip_path, 'application/zip')
+        end
+      end
+    end
+  end
+end

data/lib/replicate/client.rb

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
 
 require "replicate/configurable"
-require "replicate/connection"
+require "replicate/endpoint"
 
 require "replicate/client/model"
 require "replicate/client/prediction"
+require "replicate/client/upload"
+require "replicate/client/training"
 
 module Replicate
   class Client
     include Replicate::Configurable
-    include Replicate::Connection
 
     include Replicate::Client::Model
     include Replicate::Client::Prediction
+    include Replicate::Client::Upload
+    include Replicate::Client::Training
 
     def initialize(options = {})
       # Use options passed in, but fall back to module defaults
@@ -21,5 +24,13 @@ module Replicate
         instance_variable_set(:"@#{key}", value)
       end
     end
+
+    def api_endpoint
+      @api_endpoint ||= Replicate::Endpoint.new(endpoint_url: api_endpoint_url, api_token: api_token)
+    end
+
+    def dreambooth_endpoint
+      @dreambooth_endpoint ||= Replicate::Endpoint.new(endpoint_url: dreambooth_endpoint_url, api_token: api_token)
+    end
   end
 end

data/lib/replicate/configurable.rb

@@ -3,13 +3,13 @@
 module Replicate
   module Configurable
     attr_accessor :api_token, :webhook_url
-    attr_writer :api_endpoint
+    attr_writer :api_endpoint_url, :dreambooth_endpoint_url
 
     class << self
       # List of configurable keys for {Datatrans::Client}
       # @return [Array] of option keys
       def keys
-        @keys ||= %i[api_token api_endpoint webhook_url]
+        @keys ||= %i[api_token api_endpoint_url dreambooth_endpoint_url webhook_url]
       end
     end
 
@@ -19,8 +19,12 @@ module Replicate
     end
 
     # API endpoint methods
-    def api_endpoint
-      @api_endpoint ||= "https://api.replicate.com/v1"
+    def api_endpoint_url
+      @api_endpoint_url ||= "https://api.replicate.com/v1"
+    end
+
+    def dreambooth_endpoint_url
+      @dreambooth_endpoint_url ||= "https://dreambooth-api-experimental.replicate.com/v1"
     end
 
     private

data/lib/replicate/{connection.rb → endpoint.rb}

@@ -3,16 +3,19 @@
 require "faraday"
 require "faraday/net_http"
 require "faraday/retry"
+require "faraday/multipart"
 require "addressable/uri"
 
 module Replicate
   # Network layer for API clients.
-  module Connection
-    DEFAULT_MEDIA_TYPE = "application/json"
-    USER_AGENT = "Datatrans Ruby Gem"
+  class Endpoint
+    attr_reader :endpoint_url, :api_token, :content_type
 
-    # Header keys that can be passed in options hash to {#get},{#head}
-    CONVENIENCE_HEADERS = Set.new(%i[accept content_type])
+    def initialize(endpoint_url:, api_token:, content_type: 'application/json')
+      @endpoint_url = endpoint_url
+      @api_token = api_token
+      @content_type = content_type
+    end
 
     # Make a HTTP GET request
     #
@@ -72,11 +75,10 @@ module Replicate
     #
     # @return [Sawyer::Agent]
     def agent
-      @agent ||= Faraday.new(url: endpoint) do |conn|
+      @agent ||= Faraday.new(url: endpoint_url) do |conn|
         conn.request :retry
-        conn.request :authorization, 'Token', api_token
-        conn.headers["Content-Type"] = DEFAULT_MEDIA_TYPE
-        conn.headers["Accept"] = DEFAULT_MEDIA_TYPE
+        conn.request :authorization, 'Token', api_token if api_token
+        conn.headers["Content-Type"] = content_type
 
         conn.adapter :net_http
       end
@@ -89,12 +91,6 @@ module Replicate
       @last_response if defined? @last_response
     end
 
-    protected
-
-    def endpoint
-      api_endpoint
-    end
-
     private
 
     def request(method, path, data)
@@ -103,7 +99,12 @@ module Replicate
       when 400
         raise Error, "#{@last_response.status} #{@last_response.reason_phrase}: #{JSON.parse(@last_response.body)}"
       else
-        JSON.parse(@last_response.body)
+        case content_type
+        when 'application/json'
+          JSON.parse(@last_response.body)
+        else
+          @last_response.body
+        end
       end
     end
   end

data/lib/replicate/record/training.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Replicate
+  module Record
+    class Training < Base
+      def refetch
+        @data = client.retrieve_training(id).data
+      end
+    end
+  end
+end

data/lib/replicate/record/upload.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Replicate
+  module Record
+    class Upload < Base
+      def attach(path)
+        client.update_upload(upload_url, path)
+      end
+    end
+  end
+end

data/lib/replicate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Replicate
-  VERSION = "0.1.7"
+  VERSION = "0.2.1"
 end

data/lib/replicate.rb

@@ -7,6 +7,8 @@ require "replicate/record/base"
 require "replicate/record/model"
 require "replicate/record/model_version"
 require "replicate/record/prediction"
+require "replicate/record/upload"
+require "replicate/record/training"
 
 module Replicate
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: replicate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.1
 platform: ruby
 authors:
 - Dreaming Tulpa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-19 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - hey@dreamingtulpa.com
@@ -93,16 +121,21 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- data.zip
 - lib/replicate.rb
 - lib/replicate/client.rb
 - lib/replicate/client/model.rb
 - lib/replicate/client/prediction.rb
+- lib/replicate/client/training.rb
+- lib/replicate/client/upload.rb
 - lib/replicate/configurable.rb
-- lib/replicate/connection.rb
+- lib/replicate/endpoint.rb
 - lib/replicate/record/base.rb
 - lib/replicate/record/model.rb
 - lib/replicate/record/model_version.rb
 - lib/replicate/record/prediction.rb
+- lib/replicate/record/training.rb
+- lib/replicate/record/upload.rb
 - lib/replicate/version.rb
 - sig/replicate/ruby.rbs
 homepage: https://github.com/dreamingtulpa/replicate-ruby
@@ -126,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Ruby client for Replicate