xapixctl 1.1.2 → 1.2.4

data/lib/xapixctl/titan_cli.rb

@@ -0,0 +1,286 @@
+# frozen_string_literal: true
+
+require 'xapixctl/base_cli'
+
+module Xapixctl
+  class TitanCli < BaseCli
+    DEFAULT_METHODS = {
+      "predict" => :predict,
+      "performance" => :performance,
+    }.freeze
+
+    option :schema_import, desc: "Resource id of an existing Schema import"
+    option :data, desc: "JSON encoded data for predict API", default: "[[1,2,3]]"
+    desc "service URL", "build a service for the deployed model"
+    long_desc <<-LONGDESC
+      `xapixctl titan service URL` will build a ML service around a deployed ML model.
+
+      We expect the following of the deployed ML model:
+
+      - There should be a "POST /predict" endpoint. Use --data="JSON" to specify an example dataset the model expects.
+
+      - If there is a "GET /performance" endpoint, it'll be made available. It's expected to return a JSON object with the properties 'accuracy', 'precision', 'recall', and 'min_acc_threshold'.
+
+      Examples:
+      \x5> $ xapixctl titan service https://services.demo.akoios.com/ai-model-name -p xapix/ml-project
+    LONGDESC
+    def service(akoios_url)
+      url = URI.parse(akoios_url)
+      schema = JSON.parse(RestClient.get(File.join(url.to_s, 'spec'), params: { host: url.hostname }, headers: { accept: :json }))
+      patch_schema(schema)
+      connector_refs = import_swagger(File.basename(url.path), schema)
+      say "\n== Onboarding Connectors", :bold
+      connectors = match_connectors_to_action(connector_refs)
+      if connectors.empty?
+        warn "\nNo valid connectors for ML service detected, not building service."
+        exit 1
+      end
+      say "\n== Building Service", :bold
+      service_doc = build_service(schema.dig('info', 'title'), connectors)
+      res = prj_connection.apply(service_doc)
+      say "\ncreated / updated service #{res.first}"
+    end
+
+    private
+
+    def patch_schema(schema)
+      predict_schema = schema.dig('paths', '/predict', 'post')
+      if predict_schema
+        predict_data = JSON.parse(options[:data]) rescue {}
+        predict_schema['operationId'] = 'predict'
+        predict_schema['parameters'].each do |param|
+          if param['name'] == 'json' && param['in'] == 'body'
+            param['schema']['properties'] = { "data" => extract_schema(predict_data) }
+            param['schema']['example'] = { "data" => predict_data }
+          end
+        end
+      end
+
+      performane_schema = schema.dig('paths', '/performance', 'get')
+      if performane_schema
+        performane_schema['operationId'] = 'performance'
+      end
+    end
+
+    def import_swagger(filename, schema)
+      Tempfile.create([filename, '.json']) do |f|
+        f.write(schema.to_json)
+        f.rewind
+
+        if options[:schema_import]
+          result = prj_connection.update_schema_import(options[:schema_import], f)
+          say "updated #{result.dig('resource', 'kind')} #{result.dig('resource', 'id')}"
+        else
+          result = prj_connection.add_schema_import(f)
+          say "created #{result.dig('resource', 'kind')} #{result.dig('resource', 'id')}"
+        end
+        result.dig('schema_import', 'updated_resources')
+      end
+    end
+
+    def match_connectors_to_action(connector_refs)
+      connector_refs.map do |connector_ref|
+        connector = prj_connection.resource(connector_ref['kind'], connector_ref['id'])
+        action = DEFAULT_METHODS[connector.dig('definition', 'name')]
+        say "\n#{connector['kind']} #{connector.dig('definition', 'name')} -> "
+        if action
+          say "#{action} action"
+          updated_connector = update_connector_with_preview(connector)
+          [action, updated_connector] if updated_connector
+        else
+          say "no action type detected, ignoring"
+          nil
+        end
+      end.compact
+    end
+
+    def update_connector_with_preview(connector)
+      say "fetching preview for #{connector['kind']} #{connector.dig('definition', 'name')}..."
+      preview_details = prj_connection.data_source_preview(connector.dig('metadata', 'id'))
+      preview = preview_details.dig('preview', 'sample')
+      say "got a #{preview['status']} response: #{preview['body']}"
+      if preview['status'] != 200
+        say "unexpected status, please check data or model"
+      elsif yes?("Does this look alright?", :bold)
+        res = prj_connection.accept_data_source_preview(connector.dig('metadata', 'id'))
+        return res.dig('data_source', 'resource_description')
+      end
+      nil
+    end
+
+    def extract_schema(data_sample)
+      case data_sample
+      when Array
+        { type: 'array', items: extract_schema(data_sample[0]) }
+      when Hash
+        { type: 'object', properties: data_sample.transform_values { |v| extract_schema(v) } }
+      when Numeric
+        { type: 'number' }
+      else
+        {}
+      end
+    end
+
+    def build_service(title, connectors)
+      {
+        version: 'v1',
+        kind: 'Service',
+        metadata: { id: title.parameterize },
+        definition: {
+          name: title.humanize,
+          actions: connectors.map { |action, connector| build_service_action(action, connector) }
+        }
+      }
+    end
+
+    def build_service_action(action_type, connector)
+      {
+        name: action_type,
+        parameter_schema: parameter_schema(action_type, connector),
+        result_schema: result_schema(action_type),
+        pipeline: { units: pipeline_units(action_type, connector) }
+      }
+    end
+
+    def parameter_schema(action_type, connector)
+      case action_type
+      when :predict
+        { type: 'object', properties: {
+          data: connector.dig('definition', 'parameter_schema', 'properties', 'body', 'properties', 'data'),
+        } }
+      when :performance
+        { type: 'object', properties: {} }
+      end
+    end
+
+    def result_schema(action_type)
+      case action_type
+      when :predict
+        { type: 'object', properties: {
+          prediction: { type: 'object', properties: { percent: { type: 'number' }, raw: { type: 'number' } } },
+          success: { type: 'boolean' },
+          error: { type: 'string' }
+        } }
+      when :performance
+        { type: 'object', properties: {
+          performance: {
+            type: 'object', properties: {
+              accuracy: { type: 'number' },
+              precision: { type: 'number' },
+              recall: { type: 'number' },
+              min_acc_threshold: { type: 'number' }
+            }
+          }
+        } }
+      end
+    end
+
+    def pipeline_units(action_type, connector)
+      case action_type
+      when :predict
+        [entry_unit, predict_unit(connector), predict_result_unit]
+      when :performance
+        [entry_unit, performance_unit(connector), performance_result_unit]
+      end
+    end
+
+    def entry_unit
+      { version: 'v2', kind: 'Unit/Entry',
+        metadata: { id: 'entry' },
+        definition: { name: 'Entry' } }
+    end
+
+    def predict_unit(connector)
+      leafs = extract_leafs(connector.dig('definition', 'parameter_schema', 'properties', 'body'))
+      { version: 'v2', kind: 'Unit/DataSource',
+        metadata: { id: 'predict' },
+        definition: {
+          name: 'Predict',
+          inputs: ['entry'],
+          data_source: connector.dig('metadata', 'id'),
+          formulas: leafs.map { |leaf|
+            { ref: leaf[:node]['$id'], formula: (['', 'entry'] + leaf[:path]).join('.') }
+          }
+        } }
+    end
+
+    def predict_result_unit
+      { version: 'v2', kind: 'Unit/Result',
+        metadata: { id: 'result' },
+        definition: {
+          name: 'Result',
+          inputs: ['predict'],
+          formulas: [{
+            ref: "#prediction.percent",
+            formula: "IF(.predict.status = 200, ROUND(100*coerce.to-float(.predict.body), 2))"
+          }, {
+            ref: "#prediction.raw",
+            formula: "IF(.predict.status = 200, coerce.to-float(.predict.body))"
+          }, {
+            ref: "#success",
+            formula: ".predict.status = 200"
+          }, {
+            ref: "#error",
+            formula: "IF(.predict.status <> 200, 'Model not trained!')"
+          }],
+          parameter_sample: {
+            "prediction" => { "percent" => 51.12, "raw" => 0.5112131 },
+            "success" => true,
+            "error" => nil
+          }
+        } }
+    end
+
+    def performance_unit(connector)
+      { version: 'v2', kind: 'Unit/DataSource',
+        metadata: { id: 'performance' },
+        definition: {
+          name: 'Performance',
+          inputs: ['entry'],
+          data_source: connector.dig('metadata', 'id')
+        } }
+    end
+
+    def performance_result_unit
+      { version: 'v2', kind: 'Unit/Result',
+        metadata: { id: 'result' },
+        definition: {
+          name: 'Result',
+          inputs: ['performance'],
+          formulas: [{
+            ref: "#performance.recall",
+            formula: "WITH(data, JSON.DECODE(REGEXREPLACE(performance.body, \"'\", \"\\\"\")), .data.recall)"
+          }, {
+            ref: "#performance.accuracy",
+            formula: "WITH(data, JSON.DECODE(REGEXREPLACE(performance.body, \"'\", \"\\\"\")), .data.accuracy)"
+          }, {
+            ref: "#performance.precision",
+            formula: "WITH(data, JSON.DECODE(REGEXREPLACE(performance.body, \"'\", \"\\\"\")), .data.precision)"
+          }, {
+            ref: "#performance.min_acc_threshold",
+            formula: "WITH(data, JSON.DECODE(REGEXREPLACE(performance.body, \"'\", \"\\\"\")), .data.min_acc_threshold)"
+          }],
+          parameter_sample: {
+            "performance" => {
+              "recall" => 0.8184713375796179,
+              "accuracy" => 0.9807847896440129,
+              "precision" => 0.8711864406779661,
+              "min_acc_threshold" => 0.84,
+            }
+          }
+        } }
+    end
+
+    def extract_leafs(schema, current_path = [])
+      return unless schema
+      case schema['type']
+      when 'object'
+        schema['properties'].flat_map { |key, sub_schema| extract_leafs(sub_schema, current_path + [key]) }.compact
+      when 'array'
+        extract_leafs(schema['items'], current_path + [:[]])
+      else
+        { path: current_path, node: schema }
+      end
+    end
+  end
+end

data/lib/xapixctl/util.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Xapixctl
+  module Util
+    extend self
+
+    class InvalidDocumentStructureError < StandardError
+      def initialize(file)
+        super("#{file} has invalid document structure")
+      end
+    end
+
+    DOCUMENT_STRUCTURE = %w[version kind metadata definition].freeze
+
+    def resources_from_file(filename, ignore_missing: false)
+      load_files(filename, ignore_missing) do |actual_file, yaml_string|
+        yaml_string.split(/^---\s*\n/).map { |yml| Psych.safe_load(yml) }.compact.each do |doc|
+          raise InvalidDocumentStructureError, actual_file unless (DOCUMENT_STRUCTURE - doc.keys.map(&:to_s)).empty?
+          yield doc
+        end
+      end
+    end
+
+    def load_files(filename, ignore_missing)
+      if filename == '-'
+        yield 'STDIN', $stdin.read
+      else
+        pn = filename.is_a?(Pathname) ? filename : Pathname.new(filename)
+        if pn.directory?
+          pn.glob(["**/*.yaml", "**/*.yml"]).sort.each { |dpn| yield dpn.to_s, dpn.read }
+        elsif pn.exist?
+          yield pn.to_s, pn.read
+        elsif !ignore_missing
+          warn "file not found: #{filename}"
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/xapixctl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Xapixctl
-  VERSION = "1.1.2"
+  VERSION = "1.2.4"
 end

data/xapixctl.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "xapixctl/version"
@@ -24,13 +26,19 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.6'
+
   spec.add_dependency "activesupport", ">= 5.2.3", "< 6.0.0"
+  spec.add_dependency "hashdiff", ">= 1.0.1", "< 1.2.0"
   spec.add_dependency "rest-client", ">= 2.1.0", "< 3.0.0"
-  spec.add_dependency "thor", ">= 1.0.0", "< 1.1.0"
+  spec.add_dependency "thor", ">= 1.0.0", "< 1.2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.17.3"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "relaxed-rubocop", "~> 2.5"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 0.89"
+  spec.add_development_dependency "rspec", "~> 3.10.0"
+  spec.add_development_dependency "rubocop", "~> 1.11.0"
+  spec.add_development_dependency "rubocop-rake", "~> 0.5.1"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.2.0"
+  spec.add_development_dependency "webmock", "~> 3.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xapixctl
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.4
 platform: ruby
 authors:
 - Michael Reinsch
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,6 +30,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +79,7 @@ dependencies:
         version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,21 +89,21 @@ dependencies:
         version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -118,28 +138,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.89'
+        version: 1.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.89'
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
 description:
 email:
 - michael@xapix.io
@@ -148,6 +210,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/cd.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -163,8 +226,16 @@ files:
 - lib/xapixctl.rb
 - lib/xapixctl/base_cli.rb
 - lib/xapixctl/cli.rb
+- lib/xapixctl/connector_cli.rb
 - lib/xapixctl/phoenix_client.rb
+- lib/xapixctl/phoenix_client/connection.rb
+- lib/xapixctl/phoenix_client/organization_connection.rb
+- lib/xapixctl/phoenix_client/project_connection.rb
+- lib/xapixctl/phoenix_client/result_handler.rb
 - lib/xapixctl/preview_cli.rb
+- lib/xapixctl/sync_cli.rb
+- lib/xapixctl/titan_cli.rb
+- lib/xapixctl/util.rb
 - lib/xapixctl/version.rb
 - xapixctl.gemspec
 homepage: https://github.com/xapix-io/xapixctl
@@ -181,14 +252,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: xapix client library and command line tool