# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: 'Monitor Fairness - Watson OpenScale'
description: |
  Enable model fairness monitoring on Watson OpenScale.
metadata:
  annotations: {platform: 'IBM Watson OpenScale'}
inputs:
  - {name: model_name,            description: 'Deployed model name on OpenScale.', default: 'AIOS Spark German Risk Model - Final'}
  - {name: fairness_threshold,    description: 'Amount of threshold for fairness monitoring.', default: '0.95'}
  - {name: fairness_min_records,  description: 'Minimum amount of records for performing a fairness monitor.', default: '5'}
  - {name: aios_manifest_path,    description: 'Object storage file path for the aios manifest file.', default: 'aios.json'}
  - {name: cos_bucket_name,       description: 'Object storage bucket name.', default: 'bucket-name'}
  - {name: data_filename,         description: 'Name of the data binary', default: ''}
implementation:
  container:
    image: docker.io/aipipeline/monitor_fairness:latest
    command: ['python']
    args: [
      -u, monitor_fairness.py,
      --model_name, {inputValue: model_name},
      --fairness_threshold, {inputValue: fairness_threshold},
      --fairness_min_records, {inputValue: fairness_min_records},
      --aios_manifest_path, {inputValue: aios_manifest_path},
      --cos_bucket_name, {inputValue: cos_bucket_name},
      --data_filename, {inputValue: data_filename}
    ]