Exponenta Banner
exponenta event banner

compiler.build.pythonPackage

Создайте пакет Python для развертывания вне MATLAB

свернуть все на странице

Синтаксис

compiler.build.pythonPackage(FunctionFiles)
compiler.build.pythonPackage(FunctionFiles,Name,Value)
compiler.build.pythonPackage(opts)
results = compiler.build.pythonPackage(___)

Описание

пример

compiler.build.pythonPackage(FunctionFiles) создает Python® пакет с помощью MATLAB® функции заданы FunctionFiles.

пример

compiler.build.pythonPackage(FunctionFiles,Name,Value) создает пакет Python с дополнительными опциями, заданными с помощью одних или нескольких аргументов name-value. Опции включают имя пакета, выводят директорию и дополнительные файлы, чтобы включать.

пример

compiler.build.pythonPackage(opts) создает пакет Python с опциями, заданными с помощью compiler.build.PythonPackageOptions объект opts. Вы не можете задать никакие другие опции с помощью аргументов name-value.

пример

results = compiler.build.pythonPackage(___) возвращает информацию о сборке как compiler.build.Results объект с помощью любой из комбинаций входных аргументов в предыдущих синтаксисах. Информация о сборке состоит из типа сборки, путей к скомпилированным файлам и опций сборки.

Примеры

свернуть все

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

В MATLAB найдите функцию MATLAB, которую вы хотите развернуть как пакет Python. В данном примере используйте файл magicsquare.m расположенный в matlabroot\extern\examples\compiler.

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');

Создайте пакет Python с помощью compiler.build.pythonPackage команда.

compiler.build.pythonPackage(appFile);

Функция сборки создает следующие файлы в папке под названием magicsquarepythonPackage в вашей текущей рабочей директории:

  • GettingStarted.html

  • includedSupportPackages.txt

  • example

  • mccExcludedFiles.log

  • readme.txt

  • requiredMCRProducts.txt

  • setup.py

  • unresolvedSymbols.txt

Создайте пакет Python и настройте его с помощью аргументов name-value.

В данном примере используйте файлы flames.m и flames.mat расположенный в matlabroot\extern\examples\compiler.

appFile = fullfile(matlabroot,'extern','examples','compiler','flames.m');
MATFile = fullfile(matlabroot,'extern','examples','compiler','flames.mat');

Создайте пакет Python с помощью compiler.build.pythonPackage команда. Используйте аргументы name-value, чтобы задать имя пакета, добавить MAT-файл и включить многословный выход.

compiler.build.pythonPackage(appFile,'PackageName','FlamesApp',...
    'AdditionalFiles',MATFile,...
    'Verbose','on');

Создайте несколько пакетов Python с помощью a compiler.build.PythonPackageOptions объект.

В данном примере используйте файл magicsquare.m расположенный в matlabroot\extern\examples\compiler.

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');

Создайте PythonPackageOptions объект с помощью appFile. Используйте аргументы name-value, чтобы задать общую выходную директорию, отключить автоматическое обнаружение файлов данных и включить многословный выход.

opts = compiler.build.PythonPackageOptions(appFile,...
    'OutputDir','D:\Documents\MATLAB\work\PythonPackageBatch',...
    'AutoDetectDataFiles','off',...
    'Verbose','on')
opts =

  PythonPackageOptions with properties:

            FunctionFiles: {'C:\Program Files\MATLAB\R2021b\extern\examples\compiler\magicsquare.m'}
    SampleGenerationFiles: {}
          AdditionalFiles: {}
      AutoDetectDataFiles: off
          SupportPackages: {'autodetect'}
                  Verbose: on
                OutputDir: 'D:\Documents\MATLAB\work\PythonPackageBatch'

Создайте пакет Python с помощью PythonPackageOptions объект.

compiler.build.pythonPackage(opts);

Скомпилировать использование файла функции hello.m с теми же опциями используйте запись через точку, чтобы изменить FunctionFiles аргумент существующего PythonPackageOptions объект прежде, чем запустить сборку функционирует снова.

opts.FunctionFiles = fullfile(matlabroot,'extern','examples','compiler','hello.m');
compiler.build.pythonPackage(opts);

Путем изменения FunctionFiles аргумент и рекомпиляция, можно скомпилировать несколько компонентов с помощью того же объекта опций.

Создайте пакет Python и сохраните информацию о типе сборки, сгенерированных файлах, включал пакеты поддержки и опции сборки к compiler.build.Results объект.

Компиляция с помощью файла magicsquare.m расположенный в matlabroot\extern\examples\compiler.

results = compiler.build.pythonPackage('magicsquare.m');
results = 

  Results with properties:

            BuildType: 'pythonPackage'
                Files: {3×1 cell}
IncludedSupportPackages: {}
              Options: [1×1 compiler.build.PythonPackageOptions]

Files свойство содержит пути к следующему:

  • example папка

  • setup.py

  • GettingStarted.html

Входные параметры

свернуть все

Файлы, реализующие функции MATLAB в виде вектора символов, строкового скаляра, массива строк или массива ячеек из символьных векторов. Пути к файлам могут быть относительно текущей рабочей директории или абсолюта. Файлы должны иметь .m расширение.

Пример: ["myfunc1.m","myfunc2.m"]

Типы данных: char | string | cell

Пакет Python создает опции в виде a compiler.build.PythonPackageOptions объект.

Аргументы name-value

Задайте дополнительные разделенные запятой пары Name,Value аргументы. Name имя аргумента и Value соответствующее значение. Name должен появиться в кавычках. Вы можете задать несколько аргументов в виде пар имен и значений в любом порядке, например: Name1, Value1, ..., NameN, ValueN.

Пример: 'Verbose','on'

Дополнительные файлы, чтобы включать в пакет Python в виде вектора символов, строкового скаляра, массива строк или массива ячеек из символьных векторов. Пути к файлам могут быть относительно текущей рабочей директории или абсолюта.

Пример: 'AdditionalFiles',["myvars.mat","data.txt"]

Типы данных: char | string | cell

Отметьте, чтобы автоматически включать файлы данных в виде 'on' или 'off', или как числовой или логический 1 TRUE) или 0 ложь). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом можно использовать значение этого свойства как логическое значение. Значение хранится как логическое значение включения - выключения типа matlab.lang.OnOffSwitchState.

  • Если вы устанавливаете это свойство на 'on', затем файлы данных, которые вы предоставляете как входные параметры определенным функциям (такой как load и fopen) автоматически включены в пакет.

  • Если вы устанавливаете это свойство на 'off', затем необходимо добавить файлы данных в пакет с помощью AdditionalFiles опция.

Пример: 'AutoDetectDataFiles','off'

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

Имя пакета Python в виде вектора символов или строкового скаляра. Задайте 'PackageName' как пространство имен, которое является разделенным от периода списком, таким как companyname.groupname.component. Имя сгенерированного пакета определяется к последней записи разделенного от периода списка. Имя должно начаться с буквы и содержать только буквенные символы и периоды.

Пример: 'PackageName','mathworks.pythonpackage.mymagic'

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

Файлы примера MATLAB раньше генерировали демонстрационные файлы Python для функций, включенных с пакетом в виде вектора символов, строкового скаляра, массива строк или массива ячеек из символьных векторов. Пути к файлам могут быть относительно текущей рабочей директории или абсолюта. Файлы должны иметь .m расширение.

Пример: 'SampleGenerationFiles',["sample1.m","sample2.m"]

Типы данных: char | string | cell

Путь к выходной директории, где файлы типа "build" сохранены в виде вектора символов или строкового скаляра. Путь может быть относительно текущей рабочей директории или абсолюта.

Имя по умолчанию папки сборки является именем пакета, добавленным с pythonPackage.

Пример: 'OutputDir','D:\Documents\MATLAB\work\mymagicpythonPackage'

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

Пакеты поддержки, чтобы включать в виде одной из следующих опций:

  • 'autodetect' (значение по умолчанию) — Процесс анализа зависимостей обнаруживает и включает необходимые пакеты поддержки автоматически.

  • 'none' — Никакие пакеты поддержки не включены. Используя эту опцию может вызвать ошибки периода выполнения.

  • Строковый скаляр, вектор символов или массив ячеек из символьных векторов — Только заданные пакеты поддержки включены. Чтобы перечислить установленные пакеты поддержки или используемых определенным файлом, смотрите compiler.codetools.deployableSupportPackages.

.

Пример: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}

Типы данных: char | string | cell

Отметьте, чтобы управлять многословием сборки в виде 'on' или 'off', или как числовой или логический 1 TRUE) или 0 ложь). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом можно использовать значение этого свойства как логическое значение. Значение хранится как логическое значение включения - выключения типа matlab.lang.OnOffSwitchState.

  • Если вы устанавливаете это свойство на 'on', затем окно команды MATLAB отображает информацию о прогрессе, указывающую на выход компилятора во время процесса сборки.

  • Если вы устанавливаете это свойство на 'off', затем командное окно не отображает информацию о прогрессе.

Пример: 'Verbose','on'

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

Выходные аргументы

свернуть все

Создайте результаты, возвращенные как compiler.build.Results объект. Results объект содержит:

  • Создайте тип, который является 'pythonPackage'

  • Пути к следующим элементам:

    • example папка

    • setup.py

    • GettingStarted.html

  • Список включенных пакетов поддержки

  • Создайте опции в виде PythonPackageOptions объект

Смотрите также

Введенный в R2021a

Документация MATLAB Compiler SDK

Поддержка