RegressionLinearCoderConfigurer

Кодер configurer для модели линейной регрессии с высоко-размерными данными

Описание

RegressionLinearCoderConfigurer объект является кодером configurer модели линейной регрессии (RegressionLinear) с высоко-размерными данными.

Кодер configurer предлагает удобные функции, чтобы сконфигурировать опции генерации кода, сгенерировать код C/C++ и обновить параметры модели в сгенерированном коде.

  • Сконфигурируйте опции генерации кода и задайте атрибуты кодера для линейных параметров модели при помощи свойств объектов.

  • Сгенерируйте код C/C++ для predict и update функции модели линейной регрессии при помощи generateCode. Генерация кода C/C++ требует MATLAB® Coder™.

  • Обновите параметры модели в сгенерированном коде C/C++, не имея необходимость регенерировать код. Эта функция уменьшает усилие, требуемое регенерировать, повторно развернуть, и повторно проверить код C/C++, когда вы переобучаете линейную модель с новыми данными или настройками. Прежде, чем обновить параметры модели, использовать validatedUpdateInputs подтверждать и извлекать параметры модели, чтобы обновиться.

Эта блок-схема показывает рабочий процесс генерации кода с помощью кодера configurer.

Two code generation workflows: the first after training a model, and the second after retraining the same model. First workflow, Step 1: Create a coder configurer. Step 2: Generate code. Step 3: Verify the generated code. Second workflow, Step 1: Check if the update is valid. If yes, go to Step 2; if no, go to the first step of the first workflow. Step 2: Update the model parameters in the generated code.

Для указаний и ограничений по применению генерации кода модели линейной регрессии смотрите разделы Генерации кода RegressionLinear, predict, и update.

Создание

После обучения модель линейной регрессии при помощи fitrlinear, создайте кодер configurer для модели при помощи learnerCoderConfigurer. Используйте свойства кодера configurer, чтобы задать атрибуты кодера predict и update аргументы. Затем используйте generateCode сгенерировать код C/C++ на основе заданных атрибутов кодера.

Свойства

развернуть все

predict Аргументы

Свойства, перечисленные в этом разделе, задают атрибуты кодера predict аргументы функции в сгенерированном коде.

Атрибуты кодера данных о предикторе, чтобы передать сгенерированному коду C/C++ для predict функция модели линейной регрессии в виде LearnerCoderInput объект.

Когда вы создаете кодер configurer при помощи learnerCoderConfigurer функция, входной параметр X определяет значения по умолчанию LearnerCoderInput атрибуты кодера:

  • SizeVector — Значением по умолчанию является размер массивов входа X.

    • Если Value атрибут ObservationsIn свойство для RegressionLinearCoderConfigurer 'rows', затем этот SizeVector значением является [n p], где n соответствует количеству наблюдений и p соответствует количеству предикторов.

    • Если Value атрибут ObservationsIn свойство для RegressionLinearCoderConfigurer 'columns', затем этот SizeVector значением является [p n].

    Переключить элементы SizeVector (например, чтобы изменить [n p] к [p n]), измените Value атрибут ObservationsIn свойство для RegressionLinearCoderConfigurer соответственно. Вы не можете изменить SizeVector оцените непосредственно.

  • VariableDimensions — Значением по умолчанию является [0 0], который указывает, что размер массивов фиксируется, как задано в SizeVector.

    Можно установить это значение к [1 0] если SizeVector значением является [n p] или к [0 1] если это - [p n], который указывает, что массив имеет строки переменного размера и столбцы фиксированного размера. Например, [1 0] указывает что первое значение SizeVector N) верхняя граница для количества строк и второго значения SizeVector P) количество столбцов.

  • DataType — Этим значением является single или double. Тип данных по умолчанию зависит от типа данных входа X.

  • Tunability — Этим значением должен быть true, значение этого predict в сгенерированном коде C/C++ всегда включает данные о предикторе как вход.

Можно изменить атрибуты кодера при помощи записи через точку. Например, чтобы сгенерировать код C/C++, который принимает данные о предикторе с 100 наблюдениями (в строках) трех переменных предикторов (в столбцах), задайте эти атрибуты кодера X для кодера configurer configurer:

configurer.X.SizeVector = [100 3];
configurer.X.DataType = 'double';
configurer.X.VariableDimensions = [0 0];
[0 0] указывает что первые и вторые измерения X (количество наблюдений и количество переменных предикторов, соответственно), имеют фиксированные размеры.

Чтобы позволить сгенерированному коду C/C++ принимать данные о предикторе максимум с 100 наблюдениями, задайте эти атрибуты кодера X:

configurer.X.SizeVector = [100 3];
configurer.X.DataType = 'double';
configurer.X.VariableDimensions = [1 0];
[1 0] указывает что первая размерность X (количество наблюдений), имеет переменный размер и второе измерение X (количество переменных предикторов), имеет фиксированный размер. Конкретное количество наблюдений, 100 в этом примере, становится максимальным позволенным количеством наблюдений в сгенерированном коде C/C++. Чтобы позволить любое количество наблюдений, задайте связанное как Inf.

Атрибуты кодера размерности наблюдения данных о предикторе ('ObservationsIn' аргумент пары "имя-значение" predict) в виде EnumeratedInput объект.

Когда вы создаете кодер configurer при помощи learnerCoderConfigurer функция, 'ObservationsIn' аргумент пары "имя-значение" определяет значения по умолчанию EnumeratedInput атрибуты кодера:

  • Value — Значением по умолчанию является размерность наблюдения данных о предикторе, которую вы используете при создании кодера configurer в виде 'rows' или 'columns'. Если вы не задаете 'ObservationsIn' при создании кодера configurer, значением по умолчанию является 'rows'.

  • SelectedOption — Этим значением всегда является 'Built-in'. Этот атрибут только для чтения.

  • BuiltInOptions — Массив ячеек 'rows' и 'columns'. Этот атрибут только для чтения.

  • IsConstant — Этим значением должен быть true.

  • TunabilityЗначением по умолчанию является false если вы задаете 'ObservationsIn','rows' при создании кодера configurer и true если вы задаете 'ObservationsIn','columns'. Если вы устанавливаете Tunability к false, программное обеспечение устанавливает Value к 'rows'. Если вы задаете другие значения атрибута когда Tunability false, программное обеспечение устанавливает Tunability к true.

Количество выходных аргументов, чтобы возвратиться из сгенерированного кода C/C++ для predict функция модели линейной регрессии в виде 1. predict возвращает YHat (предсказанные ответы) в сгенерированном коде C/C++.

NumOutputs свойство эквивалентно '-nargout' параметр компилятора codegen (MATLAB Coder). Эта опция задает количество выходных аргументов в функции точки входа генерации кода. Объектная функция generateCode генерирует две функции точки входа — predict.m и update.m для predict и update функции модели линейной регрессии, соответственно — и генерируют код C/C++ для двух функций точки входа. Заданное значение для NumOutputs свойство соответствует количеству выходных аргументов в функции точки входа predict.m.

Типы данных: double

update Аргументы

Свойства, перечисленные в этом разделе, задают атрибуты кодера update аргументы функции в сгенерированном коде. update функционируйте берет обученные и новые параметры модели модели в качестве входных параметров и возвращает обновленную версию модели, которая содержит новые параметры. Чтобы позволить обновить параметры в сгенерированном коде, необходимо задать атрибуты кодера параметров прежде, чем сгенерировать код. Используйте LearnerCoderInput объект задать атрибуты кодера каждого параметра. Значения атрибута по умолчанию основаны на параметрах модели во входном параметре Mdl из learnerCoderConfigurer.

Атрибуты кодера линейных коэффициентов предиктора (Beta из модели линейной регрессии) в виде LearnerCoderInput объект.

Значения атрибута по умолчанию LearnerCoderInput объект основан на входном параметре Mdl из learnerCoderConfigurer:

  • SizeVector — Этим значением должен быть [p 1], где p количество предикторов в Mdl.

  • VariableDimensions — Этим значением должен быть [0 0], указание, что размер массивов фиксируется, как задано в SizeVector.

  • DataType — Этим значением является 'single' или 'double'. Тип данных по умолчанию сопоставим с типом данных обучающих данных, которые вы используете, чтобы обучить Mdl.

  • Tunability — Этим значением должен быть true.

Атрибуты кодера термина смещения (Bias из модели линейной регрессии) в виде LearnerCoderInput объект.

Значения атрибута по умолчанию LearnerCoderInput объект основан на входном параметре Mdl из learnerCoderConfigurer:

  • SizeVector — Этим значением должен быть [1 1].

  • VariableDimensions — Этим значением должен быть [0 0], указание, что размер массивов фиксируется, как задано в SizeVector.

  • DataType — Этим значением является 'single' или 'double'. Тип данных по умолчанию сопоставим с типом данных обучающих данных, которые вы используете, чтобы обучить Mdl.

  • Tunability — Этим значением должен быть true.

Другие опции Configurer

Имя файла сгенерированного кода C/C++ в виде вектора символов.

Объектная функция generateCode из RegressionLinearCoderConfigurer генерирует код C/C++ с помощью этого имени файла.

Имя файла не должно содержать пробелы, потому что они могут привести к отказам генерации кода в определенных настройках операционной системы. Кроме того, имя должно быть допустимым именем функции MATLAB.

После создания кодера configurer configurer, можно задать имя файла при помощи записи через точку.

configurer.OutputFileName = 'myModel';

Типы данных: char

Уровень многословия в виде true (логическая единица) или false (логический ноль). Контроль уровня многословия отображение уведомлений в командной строке.

ЗначениеОписание
true (логическая единица)Программное обеспечение отображает уведомления, когда ваши изменения в атрибутах кодера параметра приводят к изменениям для других зависимых параметров.
false (логический ноль)Программное обеспечение не отображает уведомления.

Чтобы позволить обновить параметры модели машинного обучения в сгенерированном коде, необходимо сконфигурировать атрибуты кодера параметров прежде, чем сгенерировать код. Атрибуты кодера параметров зависят друг от друга, таким образом, программное обеспечение хранит зависимости как ограничения настройки. Если вы изменяете атрибуты кодера параметра при помощи кодера configurer, и модификация требует, чтобы последующие изменения к другим зависимым параметрам удовлетворили ограничениям настройки, то программное обеспечение изменяет атрибуты кодера зависимых параметров. Уровень многословия определяет, отображает ли программное обеспечение уведомления для этих последующих изменений.

После создания кодера configurer configurer, можно изменить уровень многословия при помощи записи через точку.

configurer.Verbose = false;

Типы данных: логический

Опции для индивидуальной настройки генерации кода

Чтобы настроить рабочий процесс генерации кода, используйте generateFiles функционируйте и следующие три свойства с codegen (MATLAB Coder), вместо того, чтобы использовать generateCode функция.

После генерации двух файлов функции точки входа (predict.m и update.m) при помощи generateFiles функция, можно изменить эти файлы согласно рабочему процессу генерации кода. Например, можно изменить predict.m файл, чтобы включать предварительную обработку данных, или можно добавить эти функции точки входа в другой проект генерации кода. Затем можно сгенерировать код C/C++ при помощи codegen (MATLAB Coder) функция и codegen аргументы, подходящие для модифицированных функций точки входа или проекта генерации кода. Используйте эти три свойства, описанные в этом разделе как начальная точка установленного codegen аргументы.

Это свойство доступно только для чтения.

codegen Аргументы (MATLAB Coder) в виде массива ячеек.

Это свойство позволяет вам настроить рабочий процесс генерации кода. Используйте generateCode функционируйте, если вы не должны настраивать свой рабочий процесс.

Вместо использования generateCode с кодером configurer configurer, можно сгенерировать код C/C++ можно следующим образом:

generateFiles(configurer)
cgArgs = configurer.CodeGenerationArguments;
codegen(cgArgs{:})
Если вы настраиваете рабочий процесс генерации кода, изменяете cgArgs соответственно перед вызовом codegen.

Если вы изменяете другие свойства configurer, обновления программного обеспечения CodeGenerationArguments свойство соответственно.

Типы данных: cell

Это свойство доступно только для чтения.

Список настраиваемых входных параметров точки входа функционирует predict.m для генерации кода в виде массива ячеек. Массив ячеек содержит другой массив ячеек, который включает coder.PrimitiveType (MATLAB Coder) объекты и coder.Constant (MATLAB Coder) объекты.

Если вы изменяете атрибуты кодера predict аргументы, затем обновления программного обеспечения соответствующие объекты соответственно. Если вы задаете Tunability припишите как false, затем программное обеспечение удаляет соответствующие объекты из PredictInputs список.

Массив ячеек в PredictInputs эквивалентно configurer.CodeGenerationArguments{6} для кодера configurer configurer.

Типы данных: cell

Это свойство доступно только для чтения.

Список настраиваемых входных параметров точки входа функционирует update.m для генерации кода в виде массива ячеек структуры включая coder.PrimitiveType (MATLAB Coder) объекты. Каждый coder.PrimitiveType объект включает атрибуты кодера настраиваемого параметра модели машинного обучения.

Если вы изменяете атрибуты кодера параметра модели при помощи кодера configurer свойства (update Свойства аргументов), затем обновления программного обеспечения соответствующий coder.PrimitiveType возразите соответственно. Если вы задаете Tunability атрибут параметра модели машинного обучения как false, затем программное обеспечение удаляет соответствующий coder.PrimitiveType объект от UpdateInputs список.

Структура в UpdateInputs эквивалентно configurer.CodeGenerationArguments{3} для кодера configurer configurer.

Типы данных: cell

Функции объекта

generateCodeСгенерируйте код C/C++ с помощью кодера configurer
generateFilesСгенерируйте файлы MATLAB для генерации кода, использующей кодер configurer
validatedUpdateInputsПодтвердите и извлеките параметры модели машинного обучения, чтобы обновиться

Примеры

свернуть все

Обучите модель машинного обучения, и затем сгенерируйте код для predict и update функции модели при помощи кодера configurer.

Симулируйте 10 000 наблюдений из модели

y=x100+2x200+e.

  • X=x1,...,x1000 10,000 1000 числовая матрица со стандартными нормальными элементами.

  • 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 объект.

Создайте кодер configurer для RegressionLinear модель при помощи learnerCoderConfigurer. Задайте данные о предикторе 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 RegressionLinearCoderConfigurer объект, который является кодером configurer RegressionLinear объект.

Чтобы сгенерировать код C/C++, у вас должен быть доступ к компилятору C/C++, который сконфигурирован правильно. MATLAB Coder определяет местоположение и использует поддерживаемый, установленный компилятор. Можно использовать mex -setup просмотреть и изменить компилятор по умолчанию. Для получения дополнительной информации см. Компилятор Значения по умолчанию Изменения.

Сгенерируйте код для predict и update функции модели линейной регрессии (Mdl) с настройками по умолчанию.

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

generateCode функция завершает эти действия:

  • Сгенерируйте файлы MATLAB, требуемые сгенерировать код, включая две функции точки входа predict.m и update.m для predict и update функции Mdl, соответственно.

  • Создайте MEX-функцию под названием RegressionLinearModel для двух функций точки входа.

  • Создайте код для MEX-функции в codegen\mex\RegressionLinearModel папка.

  • Скопируйте MEX-функцию в текущую папку.

Отобразите содержимое predict.m, update.m, и initialize.m файлы при помощи type функция.

type predict.m
function varargout = predict(X,varargin) %#codegen
% Autogenerated by MATLAB, 25-Aug-2021 22:31:25
[varargout{1:nargout}] = initialize('predict',X,varargin{:});
end
type update.m
function update(varargin) %#codegen
% Autogenerated by MATLAB, 25-Aug-2021 22:31:25
initialize('update',varargin{:});
end
type initialize.m
function [varargout] = initialize(command,varargin) %#codegen
% Autogenerated by MATLAB, 25-Aug-2021 22:31:25
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

Обучите модель линейной регрессии использование частичного набора данных и создайте кодер configurer для модели. Используйте свойства кодера configurer, чтобы задать атрибуты кодера параметров модели линейной регрессии. Используйте объектную функцию кодера configurer, чтобы сгенерировать код С, который предсказывает ответы для новых данных о предикторе. Затем переобучите модель с помощью целого набора данных и параметров обновления в сгенерированном коде, не регенерируя код.

Обучите модель

Симулируйте 10 000 наблюдений из модели

y=x100+2x200+e.

  • X=x1,...,x1000 10,000 1000 числовая матрица со стандартными нормальными элементами.

  • 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 объект.

Создайте кодер Конфигурера

Создайте кодер configurer для RegressionLinear модель при помощи learnerCoderConfigurer. Задайте данные о предикторе XTrain, и используйте 'ObservationsIn' аргумент пары "имя-значение", чтобы задать размерность наблюдения XTrain. learnerCoderConfigurer функционируйте использует эти входные параметры, чтобы сконфигурировать атрибуты кодера соответствующих входных параметров predict.

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

configurer RegressionLinearCoderConfigurer объект, который является кодером configurer RegressionLinear объект.

Задайте атрибуты кодера параметров

Задайте атрибуты кодера параметров модели линейной регрессии так, чтобы можно было обновить параметры в сгенерированном коде после переобучения модели. Этот пример задает атрибуты кодера данных о предикторе, которые вы хотите передать сгенерированному коду.

Задайте атрибуты кодера X свойство configurer так, чтобы сгенерированный код принял любое количество наблюдений. Измените SizeVector и VariableDimensions атрибуты. SizeVector атрибут задает верхнюю границу размера данных предиктора и VariableDimensions атрибут задает, имеет ли каждая размерность данных о предикторе переменный размер или фиксированный размер.

configurer.X.SizeVector = [1000 Inf];
configurer.X.VariableDimensions
ans = 1x2 logical array

   0   1

Размер первой размерности является количеством переменных предикторов. Это значение должно быть зафиксировано для модели машинного обучения. Поскольку данные о предикторе содержат 1 000 предикторов, значение SizeVector атрибут должен быть 1000 и значение VariableDimensions атрибутом должен быть 0.

Размер второго измерения является количеством наблюдений. Устанавливание значения 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

Когда Value атрибут ObservationsIn свойством является 'columns', первая размерность SizeVector и VariableDimensions атрибуты X соответствует количеству предикторов, и второе измерение соответствует количеству наблюдений. Когда Value атрибут ObservationsIn 'rows', порядок размерностей переключается.

Сгенерируйте код

Чтобы сгенерировать код C/C++, у вас должен быть доступ к компилятору C/C++, который сконфигурирован правильно. MATLAB Coder определяет местоположение и использует поддерживаемый, установленный компилятор. Можно использовать mex -setup просмотреть и изменить компилятор по умолчанию. Для получения дополнительной информации см. Компилятор Значения по умолчанию Изменения.

Сгенерируйте код для predict и update функции модели линейной регрессии (Mdl).

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

generateCode функция завершает эти действия:

  • Сгенерируйте файлы MATLAB, требуемые сгенерировать код, включая две функции точки входа predict.m и update.m для predict и update функции Mdl, соответственно.

  • Создайте MEX-функцию под названием RegressionLinearModel для двух функций точки входа.

  • Создайте код для MEX-функции в codegen\mex\RegressionLinearModel папка.

  • Скопируйте MEX-функцию в текущую папку.

Проверьте сгенерированный код

Передайте некоторые данные о предикторе, чтобы проверить ли predict функция Mdl и predict функция в MEX-функции возвращает те же предсказанные ответы. Чтобы вызвать функцию точки входа в MEX-функции, которая имеет больше чем одну точку входа, задайте имя функции как первый входной параметр.

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

Сравните YHat и YHat_mex.

max(abs(YHat-YHat_mex))
ans = 0

В общем случае YHat_mex может включать различия в округлении по сравнению с YHat. В этом случае сравнение подтверждает тот YHat и YHat_mex равны.

Переобучите параметры модели и обновления в сгенерированном коде

Переобучите модель с помощью целого набора данных.

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

Извлеките параметры, чтобы обновиться при помощи validatedUpdateInputs. Эта функция обнаруживает модифицированные параметры модели в retrainedMdl и подтверждает, удовлетворяют ли модифицированные значения параметров атрибутам кодера параметров.

params = validatedUpdateInputs(configurer,retrainedMdl);

Обновите параметры в сгенерированном коде.

RegressionLinearModel('update',params)

Проверьте сгенерированный код

Сравните выходные параметры от predict функция retrainedMdl и predict функция в обновленной MEX-функции.

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

Сравнение подтверждает тот YHat и YHat_mex равны.

Больше о

развернуть все

Введенный в R2019b