RegressionSolution - グローバル
RegressionSolution API は、予測インテリジェンスストアで使用されるスクリプト可能なオブジェクトです。
この API には 予測インテリジェンス プラグイン (com.glide.platform_ml) が必要で、 sn_ml 名前空間内で提供されます。
- DatasetDefinition API を使用してデータセットを作成します。
- オプション。エンコーダー API を使用してエンコーダーをビルドします。
- コンストラクターを使用して、回帰ソリューションオブジェクトを作成します。
- RegressionSolutionStore - add() メソッドを使用して、ソリューションオブジェクトを回帰ソリューションストアに追加します。
- submitTrainingJob() メソッドを使用してソリューションをトレーニングします。これにより、 RegressionSolutionVersion API を使用して管理できるオブジェクトのバージョンが作成されます。
- RegressionSolutionVersion – predict() メソッドを使用して予測を取得します。
使用上のガイドラインについては、「 ML API の使用」を参照してください。
RegressionSolution:RegressionSolution (オブジェクト構成)
回帰ソリューションを作成します。
| 名前 | タイプ | 説明 |
|---|---|---|
| 構成 | オブジェクト | の構成プロパティを含む JavaScript オブジェクト ソリューション。 |
| config.dataset | オブジェクト | DatasetDefinition 名。 |
| config.domainName | 文字列 | オプション。このデータセットに関連付けられたドメイン名。「 ドメインセパレーション」および 予測インテリジェンスを参照してください。 デフォルト:現在のドメイン ( |
| config.encoder | オブジェクト | オプション。このソリューションにアサインするトレーニング済みエンコーダーオブジェクト。。「エンコーダー - エンコーダー (オブジェクト構成)」を参照してください。 |
| config.inputFieldNames | アレイ | 文字列としての入力フィールド名のリスト。モデルは、これらのフィールドを使用して予測を行います。 |
| config.label | 文字列 | 予測タスクを識別します。 |
| config.minRowCount | 文字列 | オプション。トレーニングのためにデータセットに必要なレコードの最小数。 デフォルト:10000 |
| config.predictedFieldName | 文字列 | 設定 predictedIntervalでない限り必須です。 予測可能性のためにトレーニングするフィールドを識別します。 |
| config.predictedInterval | アレイ | 設定 predictedFieldNameでない限り必須です。ソリューションの信頼性をトレーニングするためのフィールドの範囲を設定します。2 の数値以外の日付フィールドの指定をサポートします。例:'predictedInterval': ['sys_updated_on', 'sys_created_on']。 |
| config.processingLanguage | 文字列 | オプション。2 文字の ISO 639-1 言語コード形式の処理言語。 デフォルト:「en」 |
| config.stopwords | アレイ | オプション。languageプロパティ設定に基づいてシステムが自動的に生成する文字列のプリセットリスト。詳細については、「 カスタムストップワードリストの作成」を参照してください。 デフォルト:英語のストップワード |
| config.trainingFrequency | 文字列 | モデルを再トレーニングする頻度。
可能な値:
|
次の例は、オブジェクトを作成して RegressionSolution ストア。
var myNewData = new sn_ml.DatasetDefinition(
{
'tableName' : 'incident',
'fieldNames' : ['category', 'short_description', 'priority'],
'fieldDetails' : [
{
'name' : 'category',
'type' : 'nominal'
},
{
'name' : 'short_description',
'type' : 'text'
}],
'encodedQuery' : 'activeANYTHING'
});
var mySimSolution = new sn_ml.SimilaritySolution({
'label': "my solution definition",
'dataset' : myNewData,
'predictedFieldName' : 'category',
'inputFieldNames': ['short_description']
});
var mySimilarityName = sn_ml.SimilaritySolutionStore.add(mySimSolution);
次の例は、 predictedInterval プロパティを使用してトレーニングするオブジェクトを作成する方法を示しています。
var myIncidentData = new sn_ml.DatasetDefinition({
'tableName' : 'incident',
'fieldNames' : ['short_description', 'sys_updated_on','sys_created_on'],
'encodedQuery' : 'activeANYTHING'
});
var mySolution = new sn_ml.RegressionSolution({
'label': 'reg assinGroup',
'dataset' : myIncidentData,
'predictedInterval': ['sys_updated_on', 'sys_created_on'],
'inputFieldNames': ['short_description']
});
var my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution)
RegressionSolution - cancelTrainingJob()
のジョブをキャンセル ソリューションオブジェクト トレーニングのために送信された
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、既存のトレーニングジョブをキャンセルする方法を示しています。
var mySolution = sn_ml.RegressionSolutionStore.get('ml_sn_global_global_regression');
mySolution.cancelTrainingJob();
RegressionSolution:getActiveVersion()
アクティブを取得します RegressionSolutionVersion オブジェクト。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| オブジェクト | アクティブな RegressionSolutionVersion オブジェクト。 |
次の例は 回帰ソリューション ストアからアクティブなバージョンを取得し、そのトレーニングステータスを返す
var mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');
gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus()), null, 2));
出力:
{
"state": "solution_complete",
"percentComplete": "100",
"hasJobEnded": "true"
}
RegressionSolution:getAllVersions()
のすべてのバージョンを取得しますRegressionSolution オブジェクト。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| アレイ | ソリューションオブジェクトの既存のバージョン。関連項目 回帰ソリューションバージョン API。 |
次の例は、すべての RegressionSolution バージョンオブジェクトを取得し、それらに対して getVersionNumber() および getStatus() ソリューションバージョンメソッドを呼び出す方法を示しています。
var mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');
var mlSolutionVersions = mlSolution.getAllVersions();
for (i = 0; i < mlSolutionVersions.length; i++) {
gs.print("Version " + mlSolutionVersions[i].getVersionNumber() + " Status: " + mlSolutionVersions[i].getStatus() +"\n");
};
出力:
Version 3 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}
Version 2 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}
Version 1 Status: {"state":"solution_cancelled","percentComplete":"0","hasJobEnded":"true"}
RegressionSolution:getLatestVersion()
の最新バージョンを取得します 解決策。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| オブジェクト | RegressionSolutionVersion の最新バージョンに対応するオブジェクト と RegressionSolution() を呼び出します。 |
次の例は、ソリューションの最新バージョンを取得し 、そのトレーニングステータスを返す方法を示しています。
var mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');
gs.print(JSON.stringify(JSON.parse(mlSolution.getLatestVersion().getStatus()), null, 2));
出力:
{
"state": "solution_complete",
"percentComplete": "100",
"hasJobEnded": "true"
}
RegressionSolution:getName()
ストアとのインタラクションに使用するオブジェクトの名前を取得します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | ソリューションオブジェクトの名前。 |
次の例は、 回帰ソリューション データセット情報を更新し、オブジェクトの名前を出力
// Update solution
var myIncidentData = new sn_ml.DatasetDefinition({
'tableName' : 'incident',
'fieldNames' : ['category', 'short_description', 'priority'],
'encodedQuery' : 'activeANYTHING'
});
var eligibleFields = JSON.parse(myIncidentData.getEligibleFields('regression'));
var myRegression = new sn_ml.RegressionSolution({
'label': "my regression solution",
'dataset' : myIncidentData,
'inputFieldNames': eligibleFields['eligibleInputFieldNames'],
'predictedFieldName': 'category'
});
// update solution
sn_ml.RegressionSolutionStore.update('ml_x_snc_global_global_my_solution_definition_4', myRegression);
// print solution name
gs.print('Solution Name: '+myRegression.getName());
出力:
Solution Name: ml_x_snc_global_global_my_solution_definition_4
RegressionSolution:getProperties()
ソリューションオブジェクトプロパティを取得します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| オブジェクト | RegressionSolutionStore 内の Dataset と RegressionSolution() オブジェクトの詳細の内容。 |
| <Object>.datasetProperties | ソリューションに関連付けられている DatasetDefinition() オブジェクトのプロパティを一覧表示します。
データタイプ:オブジェクト。 |
| <Object>.datasetProperties.tableName | データセットのテーブルの名前。たとえば、「 tableName」:「インシデント」です。 データタイプ:文字列。 |
| <Object>.datasetProperties.fieldNames | 指定されたテーブルのフィールド名を文字列としてリストします。例:"fieldNames" : ["short_description", "priority"]。 データタイプ:アレイ。 |
| <Object>.datasetProperties.fieldNames.fieldDetails | フィールドのプロパティを指定する JavaScript オブジェクトのリスト。
データタイプ:アレイ。 |
| <Object>.datasetProperties.fieldNames.fieldDetails.<object>.名前 | このデータセットを制限する情報のタイプを定義するフィールドの名前。 データタイプ:文字列。 |
| <Object>.datasetProperties.fieldDetails.<object>.タイプ | 機械学習フィールドタイプ。 データタイプ:文字列。 |
| <Object>.datasetProperties.fieldDetails.encodedQuery | 標準の Glide 形式でエンコードされたクエリ文字列。「 エンコードされたクエリ文字列」を参照してください。 データタイプ:文字列。 |
| <Object>.domainName | このデータセットに関連付けられたドメイン名。「 ドメインセパレーション」および 予測インテリジェンスを参照してください。 データタイプ:文字列。 |
| <Object>.encoder | このソリューションにアサインされたエンコーダーオブジェクト。。「エンコーダー - エンコーダー (オブジェクト構成)」を参照してください。 データタイプ:オブジェクト。 |
| <Object>.inputFieldNames | 文字列としての入力フィールド名のリスト。モデルは、これらのフィールドを使用して予測を行います。 データタイプ:文字列。 |
| <Object>.label | 予測タスクを識別します。
データタイプ:文字列。 |
| <Object>.name | システムによって割り当てられた名前。 データタイプ:文字列。 |
| <Object>.predictedFieldName | 予測可能性のためにトレーニングするフィールドを識別します。 データタイプ:文字列。 |
| <Object>.predictedInterval | 予測の信頼性レベルを指定する値の範囲。 データタイプ:アレイ |
| <Object>.processingLanguage | 2 文字の ISO 639-1 言語コード形式の処理言語。 データタイプ:文字列。 |
| <Object>.scope | オブジェクトスコープ。現時点で有効な値は グローバル値のみです。データタイプ:文字列 |
| <Object>.stopwords | オプション。languageプロパティ設定に基づいてシステムが自動的に生成する文字列のプリセットリスト。詳細については、「 カスタムストップワードリストの作成」を参照してください。 データタイプ:アレイ。 |
| <Object>.trainingFrequency | モデルを再トレーニングする頻度。 可能な値:
データタイプ:文字列。 |
次の例では、 ストア内のソリューションオブジェクトのプロパティを取得し ます。
var mySolution = sn_ml.RegressionSolutionStore.get('ml_sn_global_global_regression_solution');
gs.print(JSON.stringify(JSON.parse(mySolution.getProperties()), null, 2));
*** Script: {
"datasetProperties": {
"tableName": "cloudinfratext",
"fieldNames": [
"short_description",
"sourcedc",
"targetdc",
"dbsize",
"duration"
]
},
"domainName": "global",
"encoderProperties": {
"datasetsProperties": [],
"name": "wc_regression"
},
"inputFieldNames": [
"short_description",
"sourcedc",
"targetdc",
"dbsize"
],
"label": "Regression Test for DB Restore",
"name": "ml_x_snc_global_global_regression",
"predictedFieldName": "duration",
"processingLanguage": "en",
"scope": "global",
"stopwords": [
"Default English Stopwords"
],
"trainingFrequency": "every_30_days"
}RegressionSolution:getVersion(文字列 version)
ソリューションを取得します 指定されたバージョン番号で。
| 名前 | タイプ | 説明 |
|---|---|---|
| version | 文字列 | ソリューションの既存のバージョン番号。 |
| タイプ | 説明 |
|---|---|
| オブジェクト | RegressionSolutionVersion API メソッドを呼び出すことができる RegressionSolution() オブジェクトの指定されたバージョン。 |
次の例は、バージョン番号でソリューションのトレーニングステータスを取得する方法を示しています 。
var mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');
gs.print(JSON.stringify(JSON.parse(mlSolution.getVersion('1').getStatus()), null, 2));
出力:
{
"state": "solution_complete",
"percentComplete": "100",
"hasJobEnded": "true"
}
RegressionSolution:setActiveVersion(文字列 version)
ストア内の指定されたバージョンのソリューションをアクティブ化します。
| 名前 | タイプ | 説明 |
|---|---|---|
| version | 文字列 | アクティブ化する RegressionSolution() オブジェクトバージョンの名前。 このバージョンをアクティブ化すると、他のバージョンはすべて非アクティブ化されます。 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、ストアでソリューションバージョンをアクティブ化する方法を示しています。
sn_ml.RegressionSolution.setActiveVersion("ml_incident_categorization");
RegressionSolution - submitTrainingJob()
トレーニングジョブを送信します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| オブジェクト | 回帰ソリューションバージョン回 に対応するオブジェクト 帰ソリューション トレーニング対象 |
次の例は、データセットを作成し、それをソリューションに適用し、ソリューションをストアに追加して、トレーニングジョブを送信する方法を示しています。
// Create a dataset
var myData = new sn_ml.DatasetDefinition({
'tableName' : 'incident',
'fieldNames' : ['assignment_group', 'short_description', 'description'],
'encodedQuery' : 'activeANYTHING'
});
// Create a solution
var mySolution = new sn_ml.RegressionSolution({
'label': "my solution definition",
'dataset' : myData,
'predictedFieldName' : 'assignment_group',
'inputFieldNames':['short_description']
});
// Add the solution to the store to later be able to retrieve it.
var my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution);
// Train the solution - this is a long running job
var myRegressionVersion = mySolution.submitTrainingJob();