このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

RegressionLinearCoderConfigurer

高次元データをもつ線形回帰モデル用のコーダー コンフィギュアラー

R2019b 以降

説明

RegressionLinearCoderConfigurer オブジェクトは、高次元のデータを使用する線形回帰モデル (RegressionLinear) のコーダー コンフィギュアラーです。

コーダー コンフィギュアラーには、コード生成オプションの設定、C/C++ コードの生成、および生成されたコード内のモデル パラメーターの更新を行うための便利な機能があります。

• コード生成オプションを設定し、オブジェクトのプロパティを使用して線形モデル パラメーターのコーダー属性を指定します。

• generateCode を使用して、線形回帰モデルの関数 predict および update に対して C/C++ コードを生成します。C/C++ コードの生成には MATLAB^® Coder™ が必要です。

• コードを再生成せずに、生成された C/C++ コードのモデル パラメーターを更新します。この機能により、新しいデータまたは設定で線形モデルに再学習をさせるときに、C/C++ コードの再生成、再展開および再確認に必要な作業が低減されます。モデル パラメーターを更新する前に、validatedUpdateInputs を使用して更新対象のモデル パラメーターを検証および抽出します。

次のフロー チャートは、コーダー コンフィギュアラーを使用するコード生成のワークフローを示します。

線形回帰モデルのコード生成に関する使用上の注意および制限については、RegressionLinear、predict および update の「コード生成」の節を参照してください。

作成

fitrlinear を使用して線形回帰モデルに学習させた後で、learnerCoderConfigurer を使用してモデルのコーダー コンフィギュアラーを作成します。コーダー コンフィギュアラーのプロパティを使用して、predict および update の引数のコーダー属性を指定します。その後、generateCode を使用して、指定したコーダー属性に基づく C/C++ コードを生成します。

プロパティ

predict の引数

この節に記載されているプロパティは、生成されるコードにおける関数 predict の引数のコーダー属性を指定します。

X — 予測子データのコーダー属性

LearnerCoderInput オブジェクト

線形回帰モデルの関数 predict に対して生成される C/C++ コードに渡す、予測子データのコーダー属性。LearnerCoderInput オブジェクトを指定します。

関数 learnerCoderConfigurer を使用してコーダー コンフィギュアラーを作成する場合、入力引数 X は LearnerCoderInput のコーダー属性の既定値を決定します。

• SizeVector — 既定値は入力 X の配列サイズです。

  • RegressionLinearCoderConfigurer の ObservationsIn プロパティの Value 属性が 'rows' である場合、この SizeVector の値は [n p] です。ここで、n は観測値の数に対応し、p は予測子の数に対応します。

  • RegressionLinearCoderConfigurer の ObservationsIn プロパティの Value 属性が 'columns' である場合、この SizeVector の値は [p n] です。

  SizeVector の要素を切り替える (たとえば、[n p] を [p n] に変更する) には、RegressionLinearCoderConfigurer の ObservationsIn プロパティの Value 属性をそのように変更します。SizeVector の値を直接変更することはできません。

• VariableDimensions — 既定値は [0 0] です。これは、SizeVector の指定に従って配列サイズを固定することを示します。

  SizeVector の値が [n p] の場合にこの値を [1 0] に設定でき、[p n] の場合には [0 1] に設定できます。これは、配列の行が可変サイズ、列が固定サイズであることを示します。たとえば、[1 0] は、SizeVector の 1 番目の値 (n) が行数の上限であり、SizeVector の 2 番目の値 (p) が列数であることを指定します。

• DataType — この値は single または double です。既定のデータ型は、入力 X のデータ型に依存します。

• Tunability — この値は、生成される C/C++ コードの predict に必ず予測子データを入力として含めることを意味する true でなければなりません。

コーダー属性は、ドット表記を使用して変更できます。たとえば、3 つの予測子変数 (列) に対する 100 個の観測値 (行) が含まれている予測子データを受け入れる C/C++ コードを生成するには、次のようにコーダー コンフィギュアラー configurer の X のコーダー属性を指定します。

configurer.X.SizeVector = [100 3];
configurer.X.DataType = 'double';
configurer.X.VariableDimensions = [0 0];

[0 0] は、X の 1 番目および 2 番目の次元 (それぞれ観測値の個数と予測子変数の個数) が固定サイズであることを示します。

生成される C/C++ コードが、最大 100 個の観測値がある予測子データを受け入れるようにするには、次のように X のコーダー属性を指定します。

configurer.X.SizeVector = [100 3];
configurer.X.DataType = 'double';
configurer.X.VariableDimensions = [1 0];

[1 0] は、X の 1 番目の次元 (観測値の個数) が可変サイズであり、X の 2 番目の次元 (予測子変数の個数) が固定サイズであることを示します。指定した観測値の個数 (この例では 100) は、生成される C/C++ コードで許容される観測値の最大数になります。任意の個数の観測値を可能にするには、上限として Inf を指定します。

ObservationsIn — 予測子データにおける観測値の次元のコーダー属性

EnumeratedInput オブジェクト

予測子データにおける観測値の次元 (predict の名前と値のペアの引数 'ObservationsIn') のコーダー属性。EnumeratedInput オブジェクトを指定します。

関数 learnerCoderConfigurer を使用してコーダー コンフィギュアラーを作成する場合、'ObservationsIn' の名前と値のペアの引数は EnumeratedInput のコーダー属性の既定値を決定します。

• Value — 既定値はコーダー コンフィギュアラーを作成する際に使用する予測子データの観測値の次元であり、'rows' または 'columns' として指定します。コーダー コンフィギュアラーを作成する際に 'ObservationsIn' を指定しない場合、既定値は 'rows' です。

• SelectedOption — この値は常に 'Built-in' です。この属性は読み取り専用です。

• BuiltInOptions — 'rows' と 'columns' から構成される cell 配列。この属性は読み取り専用です。

• IsConstant — この値は true でなければなりません。

• Tunability — コーダー コンフィギュアラーを作成する際に 'ObservationsIn','rows' を指定する場合、既定値は false であり、'ObservationsIn','columns' を指定する場合は true です。Tunability を false に設定する場合、ソフトウェアは Value を 'rows' に設定します。Tunability が false である場合に他の属性値を指定すると、Tunability は true に設定されます。

NumOutputs — predict の出力の個数

1 (既定値)

線形回帰モデルの関数 predict に対して生成される C/C++ コードから返される出力引数の個数。1 を指定します。predict は、生成される C/C++ コードで YHat (予測応答) を返します。

NumOutputs プロパティは、codegen (MATLAB Coder) のコンパイラ オプション '-nargout' と等価です。このオプションは、コード生成のエントリポイント関数における出力引数の個数を指定します。オブジェクト関数 generateCode は、線形回帰モデルの関数 predict および update 用に predict.m および update.m という 2 つのエントリポイント関数をそれぞれ生成し、この 2 つのエントリポイント関数の C/C++ コードを生成します。NumOutputs プロパティについて指定した値は、エントリポイント関数 predict.m の出力引数の個数に対応します。

データ型: double

update の引数

この節に記載されているプロパティは、生成されるコードにおける関数 update の引数のコーダー属性を指定します。関数 update は、学習済みモデルと新しいモデル パラメーターを入力引数として受け入れ、新しいパラメーターが含まれている更新されたバージョンのモデルを返します。生成コード内のパラメーターを更新できるようにするには、コード生成の前にパラメーターのコーダー属性を指定する必要があります。各パラメーターのコーダー属性を指定するには、LearnerCoderInput オブジェクトを使用します。既定の属性値は、learnerCoderConfigurer の入力引数 Mdl のモデル パラメーターに基づきます。

Beta — 線形予測子の係数のコーダー属性

LearnerCoderInput オブジェクト

線形予測子の係数 (線形回帰モデルの Beta) のコーダー属性。LearnerCoderInput オブジェクトを指定します。

LearnerCoderInput オブジェクトの既定の属性値は、learnerCoderConfigurer の入力引数 Mdl に基づきます。

• SizeVector — この値は [p 1] でなければなりません。p は、Mdl 内の予測子の個数です。

• VariableDimensions — この値は、SizeVector の指定に従って配列サイズを固定することを示す [0 0] でなければなりません。

• DataType — この値は 'single' または 'double' です。既定のデータ型は、Mdl の学習に使用する学習データのデータ型に一致します。

• Tunability — この値は true でなければなりません。

Bias — バイアス項のコーダー属性

LearnerCoderInput オブジェクト

バイアス項 (線形回帰モデルの Bias) のコーダー属性。LearnerCoderInput オブジェクトを指定します。

LearnerCoderInput オブジェクトの既定の属性値は、learnerCoderConfigurer の入力引数 Mdl に基づきます。

• SizeVector — この値は [1 1] でなければなりません。

• VariableDimensions — この値は、SizeVector の指定に従って配列サイズを固定することを示す [0 0] でなければなりません。

• DataType — この値は 'single' または 'double' です。既定のデータ型は、Mdl の学習に使用する学習データのデータ型に一致します。

• Tunability — この値は true でなければなりません。

他のコンフィギュアラーのオプション

OutputFileName — 生成される C/C++ コードのファイル名

'RegressionLinearModel' (既定値) | 文字ベクトル

生成される C/C++ コードのファイル名。文字ベクトルを指定します。

RegressionLinearCoderConfigurer のオブジェクト関数 generateCode は、このファイル名を使用して C/C++ コードを生成します。

オペレーティング システムの構成によってはコード生成に失敗する可能性があるので、ファイル名には空白を含めないでください。また、名前は有効な MATLAB 関数名でなければなりません。

コーダー コンフィギュアラー configurer を作成した後で、ドット表記を使用してファイル名を指定できます。

configurer.OutputFileName = 'myModel';

データ型: char

Verbose — 詳細レベル

true (logical 1) (既定値) | false (logical 0)

詳細レベル。true (logical 1) または false (logical 0) を指定します。詳細レベルは、コマンド ラインにおける通知メッセージの表示を制御します。

値	説明
true (logical 1)	パラメーターのコーダー属性に対する変更によって他の従属するパラメーターが変化する場合、通知メッセージが表示されます。
false (logical 0)	通知メッセージは表示されません。

生成コード内の機械学習のモデル パラメーターを更新できるようにするには、コード生成の前にパラメーターのコーダー属性を構成する必要があります。パラメーターのコーダー属性は互いに依存するので、依存関係が構成の制約として保存されます。コーダー コンフィギュアラーを使用してパラメーターのコーダー属性を変更するときに、構成の制約を満たすために他の従属するパラメーターも変更する必要がある場合、従属するパラメーターのコーダー属性が変更されます。詳細レベルは、これらの引き続いて起きた変更についてメッセージを表示するかどうかを決定します。

コーダー コンフィギュアラー configurer を作成した後で、ドット表記を使用して詳細レベルを変更できます。

configurer.Verbose = false;

データ型: logical

コード生成のカスタマイズのオプション

コード生成ワークフローをカスタマイズするには、関数 generateCode を使用するのではなく、関数 generateFiles と以下の 3 つのプロパティを codegen (MATLAB Coder) で使用します。

関数 generateFiles を使用して 2 つのエントリポイント関数ファイル (predict.m および update.m) を生成した後で、独自のコード生成ワークフローに従って、これらのファイルを変更できます。たとえば、predict.m ファイルを変更してデータの前処理を含めたり、これらのエントリポイント関数を別のコード生成プロジェクトに追加したりできます。その後、関数 codegen と、変更したエントリポイント関数またはコード生成プロジェクトに適した codegen (MATLAB Coder) の引数とを使用して C/C++ コードを生成できます。引数 codegen を設定するための出発点として、このセクションで説明されている 3 つのプロパティを使用します。

CodeGenerationArguments — codegen の引数

cell 配列

この プロパティ は読み取り専用です。

codegen (MATLAB Coder) の引数。cell 配列を指定します。

このプロパティにより、コード生成ワークフローをカスタマイズできます。ワークフローをカスタマイズする必要がない場合は関数 generateCode を使用します。

generateCode をコーダー コンフィギュアラー configurer に対して使用する代わりに、次のようにして C/C++ コードを生成できます。

generateFiles(configurer)
cgArgs = configurer.CodeGenerationArguments;
codegen(cgArgs{:})

コード生成ワークフローをカスタマイズする場合、それに応じて、codegen を呼び出す前に cgArgs を変更します。

configurer の他のプロパティを変更すると、それに従って CodeGenerationArguments プロパティが更新されます。

データ型: cell

PredictInputs — predict の調整可能な入力引数のリスト

cell 配列

この プロパティ は読み取り専用です。

コード生成用のエントリポイント関数 predict.m の調整可能な入力引数のリスト。cell 配列として指定します。この cell 配列には、coder.PrimitiveType (MATLAB Coder) オブジェクトと coder.Constant (MATLAB Coder) オブジェクトが含まれている他の cell 配列を格納します。

predict の引数のコーダー属性を変更すると、それに従って対応するオブジェクトが更新されます。Tunability 属性として false を指定した場合、対応するオブジェクトが PredictInputs のリストから削除されます。

PredictInputs の cell 配列は、コーダー コンフィギュアラー configurer の configurer.CodeGenerationArguments{6} と等価です。

データ型: cell

UpdateInputs — update の調整可能な入力引数のリスト

coder.PrimitiveType オブジェクトが含まれている構造体の cell 配列

この プロパティ は読み取り専用です。

コード生成用のエントリポイント関数 update.m の調整可能な入力引数のリスト。coder.PrimitiveType (MATLAB Coder) オブジェクトが含まれている構造体の cell 配列を指定します。各 coder.PrimitiveType オブジェクトには、調整可能な機械学習モデル パラメーターのコーダー属性が格納されます。

コーダー コンフィギュアラーのプロパティ (update の引数のプロパティ) を使用してモデル パラメーターのコーダー属性を変更すると、それに従って対応する coder.PrimitiveType オブジェクトが更新されます。機械学習モデル パラメーターの Tunability 属性として false を指定した場合、対応する coder.PrimitiveType オブジェクトが UpdateInputs のリストから削除されます。

UpdateInputs の構造体は、コーダー コンフィギュアラー configurer の configurer.CodeGenerationArguments{3} と等価です。

データ型: cell

オブジェクト関数

generateCode	コーダー コンフィギュアラーの使用による C/C++ コードの生成
generateFiles	コーダー コンフィギュアラーを使用するコード生成用 MATLAB ファイルの生成
validatedUpdateInputs	更新する機械学習モデルのパラメーターの検証および抽出

例

コーダー コンフィギュアラーの使用によるコードの生成

機械学習モデルに学習させてから、コーダー コンフィギュアラーを使用して、このモデルの関数 predict および update に対してコードを生成します。

モデルから 10,000 個の観測値をシミュレーションします。

$$y=x_{100}+2x_{200}+e.$$

• $$X=x_1,...,x_{1000}$$ は、要素が標準正規である 10,000 行 1,000 列の数値行列です。

• $$e$$ は、平均が 0、標準偏差が 0.3 のランダムな正規誤差です。

rng('default') % For reproducibility
n = 10000;
p = 1000;
X = randn(n,p);
Y = X(:,100) + 2*X(:,200) + 0.3*randn(n,1);

シミュレーション データを使用して線形回帰モデルに学習させます。転置予測子行列 Xnew を fitrlinear に渡し、'ObservationsIn' の名前と値のペアの引数を使用して、Xnew の列が観測値に対応することを指定します。

Xnew = X';
Mdl = fitrlinear(Xnew,Y,'ObservationsIn','columns');

Mdl は、RegressionLinear オブジェクトです。

learnerCoderConfigurer を使用して、RegressionLinear モデルについてコーダー コンフィギュアラーを作成します。予測子データ Xnew を指定し、'ObservationsIn' の名前と値のペアの引数を使用して、Xnew の観測値の次元を指定します。関数 learnerCoderConfigurer はこれらの入力引数を使用して、predict の対応する入力引数のコーダー属性を設定します。

configurer = learnerCoderConfigurer(Mdl,Xnew,'ObservationsIn','columns')

configurer = 
  RegressionLinearCoderConfigurer with properties:

   Update Inputs:
              Beta: [1x1 LearnerCoderInput]
              Bias: [1x1 LearnerCoderInput]

   Predict Inputs:
                 X: [1x1 LearnerCoderInput]
    ObservationsIn: [1x1 EnumeratedInput]

   Code Generation Parameters:
        NumOutputs: 1
    OutputFileName: 'RegressionLinearModel'


  Properties, Methods

configurer は、RegressionLinear オブジェクトのコーダー コンフィギュアラーである RegressionLinearCoderConfigurer オブジェクトです。

C/C++ コードを生成するには、適切に設定されている C/C++ コンパイラにアクセスできなければなりません。MATLAB Coder は、サポートされているインストール済みのコンパイラを探して使用します。mex -setup を使用すると、既定のコンパイラを表示および変更できます。詳細は、既定のコンパイラの変更を参照してください。

既定の設定を使用して、線形回帰モデル (Mdl) の関数 predict および update に対するコードを生成します。

generateCode(configurer)

generateCode creates these files in output folder:
'initialize.m', 'predict.m', 'update.m', 'RegressionLinearModel.mat'
Code generation successful.

関数 generateCode は、以下の処理を実行します。

• コードを生成するために必要な MATLAB ファイルを生成する。これには、Mdl の関数 predict および update にそれぞれ対応する 2 つのエントリポイント関数 predict.m および update.m が含まれます。

• 2 つのエントリポイント関数に対して、RegressionLinearModel という名前の MEX 関数を作成する。

• MEX 関数のコードを codegen\mex\RegressionLinearModel フォルダーに作成する。

• MEX 関数を現在のフォルダーにコピーする。

関数typeを使用して、predict.m、update.m および initialize.m ファイルの内容を表示します。

type predict.m

function varargout = predict(X,varargin) %#codegen
% Autogenerated by MATLAB, 30-Jan-2023 18:03:57
[varargout{1:nargout}] = initialize('predict',X,varargin{:});
end

type update.m

function update(varargin) %#codegen
% Autogenerated by MATLAB, 30-Jan-2023 18:03:57
initialize('update',varargin{:});
end

type initialize.m

function [varargout] = initialize(command,varargin) %#codegen
% Autogenerated by MATLAB, 30-Jan-2023 18:03:57
coder.inline('always')
persistent model
if isempty(model)
    model = loadLearnerForCoder('RegressionLinearModel.mat');
end
switch(command)
    case 'update'
        % Update struct fields: Beta
        %                       Bias
        model = update(model,varargin{:});
    case 'predict'
        % Predict Inputs: X, ObservationsIn
        X = varargin{1};
        if nargin == 2
            [varargout{1:nargout}] = predict(model,X);
        else
            PVPairs = cell(1,nargin-2);
            for i = 1:nargin-2
                PVPairs{1,i} = varargin{i+1};
            end
            [varargout{1:nargout}] = predict(model,X,PVPairs{:});
        end
end
end

生成されたコードにおける線形回帰モデルのパラメーターの更新

データセットの一部を使用して線形回帰モデルに学習させ、モデルのコーダー コンフィギュアラーを作成します。コーダー コンフィギュアラーのプロパティを使用して、線形回帰モデル パラメーターのコーダー属性を指定します。コーダー コンフィギュアラーのオブジェクト関数を使用して、新しい予測子データについて応答を予測する C コードを生成します。その後、データセット全体を使用してモデルに再学習をさせ、コードを再生成せずに、生成されたコードのパラメーターを更新します。

モデルの学習

モデルから 10,000 個の観測値をシミュレーションします。

$$y=x_{100}+2x_{200}+e.$$

• $$X=x_1,...,x_{1000}$$ は、要素が標準正規である 10,000 行 1,000 列の数値行列です。

• $$e$$ は、平均が 0、標準偏差が 0.3 のランダムな正規誤差です。

rng('default') % For reproducibility
n = 10000;
p = 1000;
X = randn(n,p);
Y = X(:,100) + 2*X(:,200) + 0.3*randn(n,1);

最初の 500 個の観測値を使用して線形回帰モデルに学習させます。予測子データを転置し、'ObservationsIn' の名前と値のペアの引数を使用して、XTrain の列が観測値に対応することを指定します。

XTrain = X(1:500,:)';
YTrain = Y(1:500);
Mdl = fitrlinear(XTrain,YTrain,'ObservationsIn','columns');

Mdl は、RegressionLinear オブジェクトです。

コーダー コンフィギュアラーの作成

learnerCoderConfigurer を使用して、RegressionLinear モデルについてコーダー コンフィギュアラーを作成します。予測子データ XTrain を指定し、'ObservationsIn' の名前と値のペアの引数を使用して、XTrain の観測値の次元を指定します。関数 learnerCoderConfigurer はこれらの入力引数を使用して、predict の対応する入力引数のコーダー属性を設定します。

configurer = learnerCoderConfigurer(Mdl,XTrain,'ObservationsIn','columns');

configurer は、RegressionLinear オブジェクトのコーダー コンフィギュアラーである RegressionLinearCoderConfigurer オブジェクトです。

パラメーターのコーダー属性の指定

生成されたコードのパラメーターをモデルの再学習後に更新できるようにするため、線形回帰モデルのパラメーターのコーダー属性を指定します。この例では、生成されたコードに渡す予測子データのコーダー属性を指定します。

生成されたコードが任意の個数の観測値を受け入れるように、configurer の X プロパティのコーダー属性を指定します。属性 SizeVector および VariableDimensions を変更します。属性 SizeVector は、予測子データのサイズの上限を指定し、属性 VariableDimensions は、予測子データの各次元が可変サイズと固定サイズのどちらであるかを指定します。

configurer.X.SizeVector = [1000 Inf];
configurer.X.VariableDimensions

ans = 1x2 logical array

   0   1

1 番目の次元のサイズは、予測子変数の個数です。この値は、1 つの機械学習モデルに対して固定でなければなりません。予測子データには 1000 個の予測子が含まれているため、属性 SizeVector の値は 1000、属性 VariableDimensions の値は 0 でなければなりません。

2 番目の次元のサイズは、観測値の個数です。属性 SizeVector の値を Inf に設定すると、ソフトウェアは属性 VariableDimensions の値を 1 に変更します。言い換えると、サイズの上限は Inf であり、サイズは可変です。これは、予測子データが任意の数の観測値をもつことができることを意味しています。この指定は、コードを生成するときに観測値の個数が不明である場合に便利です。

SizeVector と VariableDimensions の次元の順序は ObservationsIn のコーダー属性に応じて変わります。

configurer.ObservationsIn

ans = 
  EnumeratedInput with properties:

             Value: 'columns'
    SelectedOption: 'Built-in'
    BuiltInOptions: {'rows'  'columns'}
        IsConstant: 1
        Tunability: 1

ObservationsIn プロパティの属性 Value が 'columns' の場合、X の属性 SizeVector と属性 VariableDimensions の 1 番目の次元は予測子の数に対応し、2 番目の次元は観察値の数に対応します。ObservationsIn の属性 Value が 'rows' の場合、次元の順序は切り替わります。

コードの生成

C/C++ コードを生成するには、適切に設定されている C/C++ コンパイラにアクセスできなければなりません。MATLAB Coder は、サポートされているインストール済みのコンパイラを探して使用します。mex -setup を使用すると、既定のコンパイラを表示および変更できます。詳細は、既定のコンパイラの変更を参照してください。

線形回帰モデル (Mdl) の関数 predict および update のコードを生成します。

generateCode(configurer)

generateCode creates these files in output folder:
'initialize.m', 'predict.m', 'update.m', 'RegressionLinearModel.mat'
Code generation successful.

関数 generateCode は、以下の処理を実行します。

• コードを生成するために必要な MATLAB ファイルを生成する。これには、Mdl の関数 predict および update にそれぞれ対応する 2 つのエントリポイント関数 predict.m および update.m が含まれます。

• 2 つのエントリポイント関数に対して、RegressionLinearModel という名前の MEX 関数を作成する。

• MEX 関数のコードを codegen\mex\RegressionLinearModel フォルダーに作成する。

• MEX 関数を現在のフォルダーにコピーする。

生成されたコードの確認

予測子データを渡して、Mdl の関数 predict と MEX 関数の関数 predict が同じ予測応答を返すかどうかを確認します。複数のエントリポイントがある MEX 関数内のエントリポイント関数を呼び出すため、1 番目の入力引数として関数名を指定します。

YHat = predict(Mdl,XTrain,'ObservationsIn','columns');
YHat_mex = RegressionLinearModel('predict',XTrain,'ObservationsIn','columns');

YHat と YHat_mex を比較します。

max(abs(YHat-YHat_mex))

ans = 0

一般的に、YHat と比較すると、YHat_mex には丸めによる差が含まれている可能性があります。この場合では、比較によって YHat と YHat_mex が等しいことが確かめられます。

モデルの再学習と生成コード内のパラメーターの更新

データセット全体を使用してモデルに再学習をさせます。

retrainedMdl = fitrlinear(X',Y,'ObservationsIn','columns');

validatedUpdateInputs を使用して、更新するパラメーターを抽出します。この関数は、retrainedMdl 内の修正されたモデル パラメーターを判別し、修正されたパラメーター値がパラメーターのコーダー属性を満たすかどうかを検証します。

params = validatedUpdateInputs(configurer,retrainedMdl);

生成されたコード内のパラメーターを更新します。

RegressionLinearModel('update',params)

生成されたコードの確認

retrainedMdl の関数 predict の出力と、更新した MEX 関数の関数 predict の出力を比較します。

YHat = predict(retrainedMdl,X','ObservationsIn','columns');
YHat_mex = RegressionLinearModel('predict',X','ObservationsIn','columns');
max(abs(YHat-YHat_mex))

ans = 0

比較によって YHat と YHat_mex が等しいことを確認します。

詳細

LearnerCoderInput オブジェクト

コーダー コンフィギュアラーは、LearnerCoderInput オブジェクトを使用して predict および update の入力引数のコーダー属性を指定します。

LearnerCoderInput オブジェクトには、生成されるコードにおける入力引数配列のプロパティを指定するための属性として、次のようなものがあります。

属性名	説明
SizeVector	対応する VariableDimensions の値が false である場合の配列サイズ。 対応する VariableDimensions の値が true の場合、配列サイズの上限。制限がない配列を可能にするには、上限として Inf を指定します。
VariableDimensions	配列の各次元が可変サイズと固定サイズのどちらであるかを指定するインジケーター。true (logical 1) または false (logical 0) を指定します。 値 true (logical 1) は、対応する次元が可変サイズであることを意味します。 値 false (logical 0) は、対応する次元が固定サイズであることを意味します。
DataType	配列のデータ型
Tunability	生成されるコードで引数を入力として predict または update に含めるかどうかを指定するインジケーター。true (logical 1) または false (logical 0) を指定します。 Tunability が false である場合に他の属性値を指定すると、Tunability は true に設定されます。

コーダー コンフィギュアラーを作成した後で、ドット表記を使用してコーダー属性を変更できます。たとえば、コーダー コンフィギュアラー configurer のバイアス項 Bias のデータ型を指定します。

configurer.Bias.DataType = 'single';

詳細レベル (Verbose) として true (既定) を指定した場合、機械学習モデルのパラメーターのコーダー属性を変更することによって他の従属するパラメーターのコーダー属性が変化すると、通知メッセージが表示されます。

EnumeratedInput オブジェクト

コーダー コンフィギュアラーは、EnumeratedInput オブジェクトを使用して、有限個の使用可能な値がある predict の入力引数のコーダー属性を指定します。

EnumeratedInput オブジェクトには、生成されるコードにおける入力引数配列のプロパティを指定するための属性として、次のようなものがあります。

属性名	説明
Value	生成されるコードにおける predict の引数の値。文字ベクトルまたは LearnerCoderInput オブジェクトを指定します。 BuiltInOptions 内の文字ベクトル — オプション名またはインデックス値を使用して BuiltInOptions のいずれかを指定できます。たとえば、1 番目のオプションを選択するには、Value として BuiltInOptions の 1 番目の文字ベクトルまたは 1 を指定します。 カスタム関数名を指定する文字ベクトル — カスタム オプションを使用するには、MATLAB の検索パス上でカスタム関数を定義し、カスタム関数の名前として Value を指定します。 LearnerCoderInput オブジェクト — IsConstant を false (logical 0) に設定した場合、以下の読み取り専用コーダー属性値を使用して Value が LearnerCoderInput オブジェクトに変更されます。これらの値は、生成されるコードの入力が可変サイズの調整可能な文字ベクトルであり、BuiltInOptions の使用可能な値のいずれかになることを指定します。 SizeVector — [1 c]。配列サイズの上限を指定します。c は、Option 内の使用可能な文字ベクトルのうち最長のものの長さです。 VariableDimensions — [0 1]。配列が可変サイズのベクトルであることを指定します。 DataType — 'char' Tunability — 1 Value の既定値は、対応する predict の引数 (BuiltInOptions 内のいずれかの文字ベクトル) の既定値に一致します。
SelectedOption	選択したオプションのステータス。'Built-in'、'Custom' または 'NonConstant' を指定します。SelectedOption は、次のように Value に従って設定されます。 'Built-in' (既定) — Value が BuiltInOptions 内のいずれかの文字ベクトルである場合 'Custom' — Value が BuiltInOptions 内の文字ベクトルではない場合 'NonConstant' — Value が LearnerCoderInput オブジェクトである場合 この属性は読み取り専用です。
BuiltInOptions	対応する predict の引数について使用可能な文字ベクトルのリスト。cell 配列を指定します。 この属性は読み取り専用です。
IsConstant	生成されるコードで配列の値がコンパイル時の定数 (coder.Constant (MATLAB Coder)) であるかどうかを指定するインジケーター。true (logical 1、既定) または false (logical 0) を指定します。 この値を false に設定した場合、Value が LearnerCoderInput オブジェクトに変更されます。
Tunability	生成されるコードで引数を入力として predict に含めるかどうかを指定するインジケーター。true (logical 1) または false (logical 0、既定) を指定します。 Tunability が false である場合に他の属性値を指定すると、Tunability は true に設定されます。

コーダー コンフィギュアラーを作成した後で、ドット表記を使用してコーダー属性を変更できます。たとえば、コーダー コンフィギュアラー configurer の ObservationsIn のコーダー属性を指定します。

configurer.ObservationsIn.Value = 'columns';

バージョン履歴

R2019b で導入

参考

learnerCoderConfigurer | RegressionLinear | update | predict

トピック

• コード生成の紹介
• 予測用のコード生成とコーダー コンフィギュアラーの使用による更新

×

例を開く

この例の変更されたバージョンがあります。編集された方の例を開きますか?

いいえ、変更されたバージョンを上書きします。 はい