公平な AI ツール アクションセット: 構文
予測モデルのバイアス指標を計算し、バイアスを軽減するためのアクションを提供します。
mitigateBiasForest アクション
フォレストモデルのバイアスを軽減します。
パラメーターの説明
* mitigateOptions={fairaitools_mitigateBiasActions_mitigateOptions}
軽減アルゴリズムの動作を調整できるパラメーターのリストを指定します。
fairaitools_mitigateBiasActions_mitigateOptions の値は次のいずれかになります:
biasMetric="DEMOGRAPHICPARITY" | "EQUALIZEDODDS" | "EQUALOPPORTUNITY" | "PREDICTIVEPARITY"
bound=double
Exponentiated Gradient Reduction アルゴリズムの境界値を指定します。
| デフォルト | 100 |
|---|---|
| 最小値 | 1 |
event="string"
関心の対象である事象を表す応答 (ターゲット) 変数のフォーマットされた値を指定します。
learningRate=double
Exponentiated Gradient Reduction アルゴリズムの更新に使用するステップサイズを指定します。
| デフォルト | 0.01 |
|---|---|
| 範囲 | (0, 1) |
logLevel=integer
印刷するログ情報のレベルを指定します。レベルが高いほど、より多くの情報が表示されます。
| デフォルト | 1 |
|---|---|
| 範囲 | 0–7 |
maxIters=integer
Exponentiated Gradient Reduction アルゴリズムを実行する最大反復回数を指定します。
| 別名 | maxIterations |
|---|---|
| デフォルト | 10 |
| 範囲 | 1–50 |
predictedVariables={{casvardesc-1} <, {casvardesc-2}, ...>}
モデルの予測を含む変数のリストを指定します。変数の順序は、responseLevels パラメーターで指定した順序と一致する必要があります。
name="string"
変数の名前を指定します。
responseLevels={"string-1" <, "string-2", ...>}
応答 (ターゲット) 変数のフォーマットされた値のリストを指定します。変数の順序は、predictedVariables パラメーターで指定した順序と一致する必要があります。event パラメーターを省略した場合、最初のフォーマットされた値が事象であるとみなされます。
| 別名 | targetLevels |
|---|
seed=double
乱数生成器のシードを指定します。デフォルトでは、乱数ストリームはコンピュータークロックからの時刻に基づいています。ゼロまたは負のシード値を指定すると、コンピュータークロックの時刻に基づく乱数ストリームも生成されます。実行の間に再現可能な乱数シーケンスが必要な場合は、0 より大きい値を指定します。
| デフォルト | 0 |
|---|
* sensitiveVariable={casvardesc}
バイアス計算で使用する感度変数を指定します。
name="string"
変数の名前を指定します。
tolerance=double
パリティ制約違反のトレランスを指定します。このパラメーターを 0 に設定すると、アクションは maxIters パラメーターで指定した最大反復回数まで学習を行います。
| デフォルト | 0.005 |
|---|---|
| 範囲 | [0–1) |
tuneBound=TRUE | FALSE
True に設定すると、境界値を調整する必要があることを指定します。
| デフォルト | FALSE |
|---|
scoreOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
astore アクションセットの score アクションで使用されるパラメーターのリストを指定します。詳細については、そのアクションのパラメーターを参照してください。
* trainOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
decisionTree アクションセットの forestTrain アクションで使用されるパラメーターのリストを指定します。詳細については、そのアクションのパラメーターを参照してください。
mitigateBiasForest アクション
フォレストモデルのバイアスを軽減します。
パラメーターの説明
* mitigateOptions={fairaitools_mitigateBiasActions_mitigateOptions}
軽減アルゴリズムの動作を調整できるパラメーターのリストを指定します。
fairaitools_mitigateBiasActions_mitigateOptions の値は次のいずれかになります:
biasMetric="DEMOGRAPHICPARITY" | "EQUALIZEDODDS" | "EQUALOPPORTUNITY" | "PREDICTIVEPARITY"
bound=double
Exponentiated Gradient Reduction アルゴリズムの境界値を指定します。
| デフォルト | 100 |
|---|---|
| 最小値 | 1 |
event="string"
関心の対象である事象を表す応答 (ターゲット) 変数のフォーマットされた値を指定します。
learningRate=double
Exponentiated Gradient Reduction アルゴリズムの更新に使用するステップサイズを指定します。
| デフォルト | 0.01 |
|---|---|
| 範囲 | (0, 1) |
logLevel=integer
印刷するログ情報のレベルを指定します。レベルが高いほど、より多くの情報が表示されます。
| デフォルト | 1 |
|---|---|
| 範囲 | 0–7 |
maxIters=integer
Exponentiated Gradient Reduction アルゴリズムを実行する最大反復回数を指定します。
| 別名 | maxIterations |
|---|---|
| デフォルト | 10 |
| 範囲 | 1–50 |
predictedVariables={{casvardesc-1} <, {casvardesc-2}, ...>}
モデルの予測を含む変数のリストを指定します。変数の順序は、responseLevels パラメーターで指定した順序と一致する必要があります。
name="string"
変数の名前を指定します。
responseLevels={"string-1" <, "string-2", ...>}
応答 (ターゲット) 変数のフォーマットされた値のリストを指定します。変数の順序は、predictedVariables パラメーターで指定した順序と一致する必要があります。event パラメーターを省略した場合、最初のフォーマットされた値が事象であるとみなされます。
| 別名 | targetLevels |
|---|
seed=double
乱数生成器のシードを指定します。デフォルトでは、乱数ストリームはコンピュータークロックからの時刻に基づいています。ゼロまたは負のシード値を指定すると、コンピュータークロックの時刻に基づく乱数ストリームも生成されます。実行の間に再現可能な乱数シーケンスが必要な場合は、0 より大きい値を指定します。
| デフォルト | 0 |
|---|
* sensitiveVariable={casvardesc}
バイアス計算で使用する感度変数を指定します。
name="string"
変数の名前を指定します。
tolerance=double
パリティ制約違反のトレランスを指定します。このパラメーターを 0 に設定すると、アクションは maxIters パラメーターで指定した最大反復回数まで学習を行います。
| デフォルト | 0.005 |
|---|---|
| 範囲 | [0–1) |
tuneBound=true | false
True に設定すると、境界値を調整する必要があることを指定します。
| デフォルト | false |
|---|
scoreOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
astore アクションセットの score アクションで使用されるパラメーターのリストを指定します。詳細については、そのアクションのパラメーターを参照してください。
* trainOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
decisionTree アクションセットの forestTrain アクションで使用されるパラメーターのリストを指定します。詳細については、そのアクションのパラメーターを参照してください。
mitigateBiasForest アクション
フォレストモデルのバイアスを軽減します。
パラメーターの説明
* mitigateOptions={fairaitools_mitigateBiasActions_mitigateOptions}
軽減アルゴリズムの動作を調整できるパラメーターのリストを指定します。
fairaitools_mitigateBiasActions_mitigateOptions の値は次のいずれかになります:
"biasMetric":"DEMOGRAPHICPARITY" | "EQUALIZEDODDS" | "EQUALOPPORTUNITY" | "PREDICTIVEPARITY"
"bound":double
Exponentiated Gradient Reduction アルゴリズムの境界値を指定します。
| デフォルト | 100 |
|---|---|
| 最小値 | 1 |
"event":"string"
関心の対象である事象を表す応答 (ターゲット) 変数のフォーマットされた値を指定します。
"learningRate":double
Exponentiated Gradient Reduction アルゴリズムの更新に使用するステップサイズを指定します。
| デフォルト | 0.01 |
|---|---|
| 範囲 | (0, 1) |
"logLevel":integer
印刷するログ情報のレベルを指定します。レベルが高いほど、より多くの情報が表示されます。
| デフォルト | 1 |
|---|---|
| 範囲 | 0–7 |
"maxIters":integer
Exponentiated Gradient Reduction アルゴリズムを実行する最大反復回数を指定します。
| 別名 | maxIterations |
|---|---|
| デフォルト | 10 |
| 範囲 | 1–50 |
"predictedVariables":[{casvardesc-1} <, {casvardesc-2}, ...>]
モデルの予測を含む変数のリストを指定します。変数の順序は、responseLevels パラメーターで指定した順序と一致する必要があります。
"name":"string"
変数の名前を指定します。
"responseLevels":["string-1" <, "string-2", ...>]
応答 (ターゲット) 変数のフォーマットされた値のリストを指定します。変数の順序は、predictedVariables パラメーターで指定した順序と一致する必要があります。event パラメーターを省略した場合、最初のフォーマットされた値が事象であるとみなされます。
| 別名 | targetLevels |
|---|
"seed":double
乱数生成器のシードを指定します。デフォルトでは、乱数ストリームはコンピュータークロックからの時刻に基づいています。ゼロまたは負のシード値を指定すると、コンピュータークロックの時刻に基づく乱数ストリームも生成されます。実行の間に再現可能な乱数シーケンスが必要な場合は、0 より大きい値を指定します。
| デフォルト | 0 |
|---|
* "sensitiveVariable":{casvardesc}
バイアス計算で使用する感度変数を指定します。
"name":"string"
変数の名前を指定します。
"tolerance":double
パリティ制約違反のトレランスを指定します。このパラメーターを 0 に設定すると、アクションは maxIters パラメーターで指定した最大反復回数まで学習を行います。
| デフォルト | 0.005 |
|---|---|
| 範囲 | [0–1) |
"tuneBound":True | False
True に設定すると、境界値を調整する必要があることを指定します。
| デフォルト | False |
|---|
scoreOptions={"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}
astore アクションセットの score アクションで使用されるパラメーターのリストを指定します。詳細については、そのアクションのパラメーターを参照してください。
* trainOptions={"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}
decisionTree アクションセットの forestTrain アクションで使用されるパラメーターのリストを指定します。詳細については、そのアクションのパラメーターを参照してください。
mitigateBiasForest アクション
フォレストモデルのバイアスを軽減します。
パラメーターの説明
* mitigateOptions=list(fairaitools_mitigateBiasActions_mitigateOptions)
軽減アルゴリズムの動作を調整できるパラメーターのリストを指定します。
fairaitools_mitigateBiasActions_mitigateOptions の値は次のいずれかになります:
biasMetric="DEMOGRAPHICPARITY" | "EQUALIZEDODDS" | "EQUALOPPORTUNITY" | "PREDICTIVEPARITY"
bound=double
Exponentiated Gradient Reduction アルゴリズムの境界値を指定します。
| デフォルト | 100 |
|---|---|
| 最小値 | 1 |
event="string"
関心の対象である事象を表す応答 (ターゲット) 変数のフォーマットされた値を指定します。
learningRate=double
Exponentiated Gradient Reduction アルゴリズムの更新に使用するステップサイズを指定します。
| デフォルト | 0.01 |
|---|---|
| 範囲 | (0, 1) |
logLevel=integer
印刷するログ情報のレベルを指定します。レベルが高いほど、より多くの情報が表示されます。
| デフォルト | 1 |
|---|---|
| 範囲 | 0–7 |
maxIters=integer
Exponentiated Gradient Reduction アルゴリズムを実行する最大反復回数を指定します。
| 別名 | maxIterations |
|---|---|
| デフォルト | 10 |
| 範囲 | 1–50 |
predictedVariables=list( list(casvardesc-1) <, list(casvardesc-2), ...>)
モデルの予測を含む変数のリストを指定します。変数の順序は、responseLevels パラメーターで指定した順序と一致する必要があります。
name="string"
変数の名前を指定します。
responseLevels=list("string-1" <, "string-2", ...>)
応答 (ターゲット) 変数のフォーマットされた値のリストを指定します。変数の順序は、predictedVariables パラメーターで指定した順序と一致する必要があります。event パラメーターを省略した場合、最初のフォーマットされた値が事象であるとみなされます。
| 別名 | targetLevels |
|---|
seed=double
乱数生成器のシードを指定します。デフォルトでは、乱数ストリームはコンピュータークロックからの時刻に基づいています。ゼロまたは負のシード値を指定すると、コンピュータークロックの時刻に基づく乱数ストリームも生成されます。実行の間に再現可能な乱数シーケンスが必要な場合は、0 より大きい値を指定します。
| デフォルト | 0 |
|---|
* sensitiveVariable=list(casvardesc)
バイアス計算で使用する感度変数を指定します。
name="string"
変数の名前を指定します。
tolerance=double
パリティ制約違反のトレランスを指定します。このパラメーターを 0 に設定すると、アクションは maxIters パラメーターで指定した最大反復回数まで学習を行います。
| デフォルト | 0.005 |
|---|---|
| 範囲 | [0–1) |
tuneBound=TRUE | FALSE
True に設定すると、境界値を調整する必要があることを指定します。
| デフォルト | FALSE |
|---|
scoreOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)
astore アクションセットの score アクションで使用されるパラメーターのリストを指定します。詳細については、そのアクションのパラメーターを参照してください。
* trainOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)
decisionTree アクションセットの forestTrain アクションで使用されるパラメーターのリストを指定します。詳細については、そのアクションのパラメーターを参照してください。