bitfab 0.64.21 → 0.64.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01e0c3dff10bb4315c2d7501e397c6e466679dd8a26ae99c98f682f7f91d0584
-  data.tar.gz: 9135b87f009d87e024b567bbf795fb78f3ca2da88560eca0c8f4a81ca9054223
+  metadata.gz: ea8473d1108c410cab9e21e334b155b36be99ddf83207260dfa510815bb8dc64
+  data.tar.gz: f6ac0d40b0a6941ab06428882ac5a66a12ed2b0c4f9f83401f315cd2592dc8c3
 SHA512:
-  metadata.gz: 8cf6468e184bcc18a6de04a739f55fcc4f35e31c8e95664ab5f054e6a260933ceaf6f3f8aea3478b0ac91756b16e84d69b6971b76549ce1152403ff3f37b6f5c
-  data.tar.gz: 4fa5a6541e6f234ae28637aba7371c40a1dd80a1800e2d4113d4fda5a507d0652fe12650458a02557661d67d1161225f66ce483daee4d6ce988d068d5494429b
+  metadata.gz: f4acbd07a27cfdb78e158193580c937346d56bcc8bf9d3c5489c71be6ac4af55d25813c01e7d359091261634020bd7a6fc852a003e176c0d107191194acfc063
+  data.tar.gz: f0005a0fc2fa952f93b8488881dbb8e7806eae1b1fa86e81dc5656949d48e035374cb9bacec418ce39650af2b0f658d514745007e1ca398b3d353f9a1df1251a

data/lib/bitfab/client.rb

@@ -137,7 +137,12 @@ module Bitfab
     #   each as { path:, before:, after: } (use "" for new/deleted files).
     #   Omit to capture automatically, or pass nil to suppress file capture.
     # @param experiment_group_id [String, nil] optional UUID grouping multiple
-    #   replay runs into a single experiment batch
+    #   replay runs into a single experiment batch. The run joins that group,
+    #   and an id no group has yet creates it
+    # @param experiment_group_name [String, nil] optional display name for the
+    #   experiment group, applied when this replay creates the group or the group
+    #   has no name yet. A group that already has a name keeps it. Requires
+    #   experiment_group_id; passing it alone raises ArgumentError
     # @param dataset_ids [Array<String>, nil] optional UUIDs of the datasets this
     #   replay runs against, for benchmarking one method against several corpora
     #   in a single run; mutually exclusive with dataset_id. Passing trace_ids
@@ -196,7 +201,7 @@ module Bitfab
     # @return [Hash] with :items, :experiment_id, :experiment_url, and the
     #   deprecated aliases :test_run_id and :test_run_url carrying the same values
     def replay(receiver, method_name = nil, trace_function_key:, limit: nil, trace_ids: nil, concurrency: nil, max_concurrency: ReplayConcurrency::UNSET,
-      name: nil, notes: nil, metadata: nil, code_change_description: Replay::CODE_CHANGE_UNSET, code_change_files: Replay::CODE_CHANGE_UNSET, experiment_group_id: nil, dataset_id: nil, dataset_ids: nil, grader_ids: nil, mock: "marked", attempts: ReplayConcurrency::UNSET, only_with_assertions: false, skip_assertion_judging: false, judge_assertions: nil, dry_run: false,
+      name: nil, notes: nil, metadata: nil, code_change_description: Replay::CODE_CHANGE_UNSET, code_change_files: Replay::CODE_CHANGE_UNSET, experiment_group_id: nil, experiment_group_name: nil, dataset_id: nil, dataset_ids: nil, grader_ids: nil, mock: "marked", attempts: ReplayConcurrency::UNSET, only_with_assertions: false, skip_assertion_judging: false, judge_assertions: nil, dry_run: false,
       adapt_inputs: nil, mock_override: nil, db_branch: nil, on_item_start: nil, on_item_finish: nil, on_progress: nil,
       on_experiment_start: nil, experimental_selective_replay: nil)
       Replay.run(
@@ -219,6 +224,7 @@ module Bitfab
         code_change_description:,
         code_change_files:,
         experiment_group_id:,
+        experiment_group_name:,
         dataset_id:,
         dataset_ids:,
         grader_ids:,

data/lib/bitfab/http_client.rb

@@ -254,6 +254,9 @@ module Bitfab
     #   each as { path:, before:, after: } (use "" for new/deleted files)
     # @param experiment_group_id [String, nil] optional UUID grouping multiple
     #   replay runs into a single experiment batch
+    # @param experiment_group_name [String, nil] optional display name for the
+    #   experiment group, applied when this replay creates the group or the group
+    #   has no name yet; only sent together with experiment_group_id
     # @param name [String, nil] optional display name for the resulting
     #   experiment
     # @param dataset_ids [Array<String>, nil] optional UUIDs of the datasets this
@@ -266,7 +269,7 @@ module Bitfab
     #   runnable graders at completion; each must be an active/live grader in the
     #   same org and trace function or the server rejects the replay
     def start_replay(trace_function_key, limit, trace_ids: nil, code_change_description: nil,
-      code_change_files: nil, experiment_group_id: nil, name: nil, notes: nil, metadata: nil, include_db_branch_lease: false, dataset_ids: nil,
+      code_change_files: nil, experiment_group_id: nil, experiment_group_name: nil, name: nil, notes: nil, metadata: nil, include_db_branch_lease: false, dataset_ids: nil,
       grader_ids: nil, db_branch_settings: nil, attempts: 1, only_with_assertions: false, skip_assertion_judging: false, include_original_metadata: false, experimental_selective_replay: nil, dry_run: false, invocation: nil)
       payload = {
         "traceFunctionKey" => trace_function_key
@@ -281,6 +284,7 @@ module Bitfab
       payload["codeChangeDescription"] = code_change_description unless code_change_description.nil?
       payload["codeChangeFiles"] = normalize_code_change_files(code_change_files) unless code_change_files.nil?
       payload["experimentGroupId"] = experiment_group_id unless experiment_group_id.nil?
+      payload["experimentGroupName"] = experiment_group_name unless experiment_group_name.nil?
       payload["includeDbBranchLease"] = true if include_db_branch_lease
       payload["lazyDbBranchLease"] = true if include_db_branch_lease
       unless dataset_ids.nil?

data/lib/bitfab/replay.rb

@@ -235,7 +235,12 @@ module Bitfab
     #   each as { path:, before:, after: } (empty string for new/deleted files).
     #   Omit to capture automatically, or pass nil to suppress file capture.
     # @param experiment_group_id [String, nil] optional UUID grouping multiple
-    #   replay runs into a single experiment batch
+    #   replay runs into a single experiment batch. The run joins that group,
+    #   and an id no group has yet creates it
+    # @param experiment_group_name [String, nil] optional display name for the
+    #   experiment group, applied when this replay creates the group or the group
+    #   has no name yet. A group that already has a name keeps it. Requires
+    #   experiment_group_id; passing it alone raises ArgumentError
     # @param dataset_id [String, nil] optional UUID of the dataset this replay
     #   runs against, stored on the resulting experiment for durable attribution;
     #   mutually exclusive with dataset_ids. Alone it replays the dataset's full
@@ -295,7 +300,7 @@ module Bitfab
     #   The experiment fields are nil for a dry run, which creates no experiment,
     #   and progress events then carry a nil :experiment_id too.
     def run(client, receiver, method_name, trace_function_key:, limit: nil, trace_ids: nil, name: nil, notes: nil, metadata: nil,
-      concurrency: nil, max_concurrency: ReplayConcurrency::UNSET, code_change_description: CODE_CHANGE_UNSET, code_change_files: CODE_CHANGE_UNSET, experiment_group_id: nil,
+      concurrency: nil, max_concurrency: ReplayConcurrency::UNSET, code_change_description: CODE_CHANGE_UNSET, code_change_files: CODE_CHANGE_UNSET, experiment_group_id: nil, experiment_group_name: nil,
       dataset_id: nil, dataset_ids: nil, grader_ids: nil, mock: "marked", attempts: ReplayConcurrency::UNSET, only_with_assertions: false, skip_assertion_judging: false, judge_assertions: nil, dry_run: false,
       adapt_inputs: nil, mock_override: nil, db_branch: nil, on_item_start: nil, on_item_finish: nil, on_progress: nil,
       on_experiment_start: nil, experimental_selective_replay: nil)
@@ -319,6 +324,9 @@ module Bitfab
       unless attempts.is_a?(Integer) && attempts.between?(1, 100)
         raise ArgumentError, "attempts must be an integer from 1 to 100."
       end
+      if experiment_group_name && experiment_group_id.nil?
+        raise ArgumentError, "experiment_group_name only applies with experiment_group_id. Pass it together with experiment_group_id."
+      end
       item_finish_callback = on_item_finish || on_progress
       if trace_ids
         raise ArgumentError, "trace_ids must contain at least one trace ID." if trace_ids.empty?
@@ -398,6 +406,7 @@ module Bitfab
         code_change_description:,
         code_change_files:,
         experiment_group_id:,
+        experiment_group_name:,
         include_db_branch_lease:,
         dataset_ids: resolved_dataset_ids,
         grader_ids:,

data/lib/bitfab/replay_registry.rb

@@ -20,7 +20,7 @@ module Bitfab
   class ReplayRegistry
     OPTION_NAMES = %i[
       limit trace_ids name notes metadata concurrency max_concurrency code_change_description
-      code_change_files experiment_group_id dataset_id dataset_ids grader_ids mock
+      code_change_files experiment_group_id experiment_group_name dataset_id dataset_ids grader_ids mock
       mock_override adapt_inputs db_branch attempts only_with_assertions skip_assertion_judging judge_assertions dry_run on_item_finish
     ].freeze
 
@@ -190,7 +190,7 @@ module Bitfab
         options[:limit] = bound || 10
       end
 
-      %i[name notes metadata max_concurrency experiment_group_id dataset_ids grader_ids mock attempts only_with_assertions skip_assertion_judging dry_run].each do |key|
+      %i[name notes metadata max_concurrency experiment_group_id experiment_group_name dataset_ids grader_ids mock attempts only_with_assertions skip_assertion_judging dry_run].each do |key|
         options[key] = args[key] unless args[key].nil?
       end
 
@@ -339,7 +339,11 @@ module Bitfab
           args[:max_concurrency] = positive_integer("--max-concurrency", value)
         end
         options.on("--code-change PATH") { |value| args[:code_change] = value }
-        options.on("--experiment-group-id UUID") { |value| args[:experiment_group_id] = value }
+        options.on("--experiment-group-id UUID",
+          "Add this run to an experiment group. A UUID no group has yet creates the group.") { |value| args[:experiment_group_id] = value }
+        options.on("--experiment-group-name NAME",
+          "Name the experiment group when this run creates it or it has no name yet. " \
+            "A group that already has a name keeps it. Requires --experiment-group-id.") { |value| args[:experiment_group_name] = value }
         options.on("--dataset-ids IDS", "--dataset-id IDS") { |value| args[:dataset_ids] = comma_separated("--dataset-ids", value) }
         options.on("--grader-ids IDS") { |value| args[:grader_ids] = comma_separated("--grader-ids", value) }
         options.on("--attempts N", Integer) { |value| args[:attempts] = positive_integer("--attempts", value) }

data/lib/bitfab/traces.rb

@@ -7,11 +7,15 @@ module Bitfab
       @http_client = http_client
     end
 
-    def search(caller_metadata: nil, name: nil, name_contains: nil, trace_function_key: nil, cursor: nil, limit: nil)
+    # Search traces by caller metadata, name, or experiment. experiment_id
+    # returns only the replay traces that experiment produced. Each result
+    # carries "durationMs" and "tokens", either of which is nil when not recorded.
+    def search(caller_metadata: nil, name: nil, name_contains: nil, experiment_id: nil, trace_function_key: nil, cursor: nil, limit: nil)
       payload = {}
       payload["callerMetadata"] = caller_metadata unless caller_metadata.nil?
       payload["name"] = name unless name.nil?
       payload["nameContains"] = name_contains unless name_contains.nil?
+      payload["experimentId"] = experiment_id unless experiment_id.nil?
       payload["traceFunctionKey"] = trace_function_key unless trace_function_key.nil?
       payload["cursor"] = cursor unless cursor.nil?
       payload["limit"] = limit unless limit.nil?

data/lib/bitfab/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bitfab
-  VERSION = "0.64.21"
+  VERSION = "0.64.23"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitfab
 version: !ruby/object:Gem::Version
-  version: 0.64.21
+  version: 0.64.23
 platform: ruby
 authors:
 - Harvest Team