CINXE.COM
Core ML Model Format Specification — Core ML Format Reference documentation
<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Core ML Model Format Specification — Core ML Format Reference documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="_static/graphviz.css" type="text/css" /> <!--[if lt IE 9]> <script src="_static/js/html5shiv.min.js"></script> <![endif]--> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/jquery.js"></script> <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Core ML Model" href="Format/Model.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="#" class="icon icon-home"> Core ML Format Reference </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul> <li class="toctree-l1"><a class="reference internal" href="Format/Model.html">Core ML Model</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/DataStructuresTypes.html">Data Structures, Types and Parameters</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/FeatureEngineering.html">Feature Engineering</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/Identity.html">Identity</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/MIL.html">MILspec.Program</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/NeuralNetwork.html">NeuralNetwork</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/Classifiers.html">Other Classifiers</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/OtherModels.html">Other Models</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/Regressors.html">Other Regressors</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/SVM.html">Support Vector Machine</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/TreeEnsemble.html">TreeEnsemble</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Resources</span></p> <ul> <li class="toctree-l1"><a class="reference external" href="https://coremltools.readme.io/docs">Guides and examples</a></li> <li class="toctree-l1"><a class="reference external" href="https://apple.github.io/coremltools/index.html">Core ML Tools (coremltools) API</a></li> <li class="toctree-l1"><a class="reference external" href="https://github.com/apple/coremltools/tree/main/mlmodel">GitHub</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="#">Core ML Format Reference</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="#" class="icon icon-home"></a> »</li> <li>Core ML Model Format Specification</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="core-ml-model-format-specification"> <h1>Core ML Model Format Specification<a class="headerlink" href="#core-ml-model-format-specification" title="Permalink to this heading"></a></h1> <p>This document contains the protobuf message definitions that comprise the Core ML model format. The top-level message is <cite>Model</cite>, which is defined in <code class="file docutils literal notranslate"><span class="pre">Model.proto</span></code>. Other message types describe data structures, feature types, feature engineering model types, and predictive model types.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="Format/Model.html">Core ML Model</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/DataStructuresTypes.html">Data Structures, Types and Parameters</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/FeatureEngineering.html">Feature Engineering</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/Identity.html">Identity</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/MIL.html">MILspec.Program</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/NeuralNetwork.html">NeuralNetwork</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/Classifiers.html">Other Classifiers</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/OtherModels.html">Other Models</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/Regressors.html">Other Regressors</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/SVM.html">Support Vector Machine</a></li> <li class="toctree-l1"><a class="reference internal" href="Format/TreeEnsemble.html">TreeEnsemble</a></li> </ul> </div> <div class="toctree-wrapper compound"> <p class="caption" role="heading"><span class="caption-text">Resources</span></p> <ul> <li class="toctree-l1"><a class="reference external" href="https://coremltools.readme.io/docs">Guides and examples</a></li> <li class="toctree-l1"><a class="reference external" href="https://apple.github.io/coremltools/index.html">Core ML Tools (coremltools) API</a></li> <li class="toctree-l1"><a class="reference external" href="https://github.com/apple/coremltools/tree/main/mlmodel">GitHub</a></li> </ul> </div> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="Format/Model.html" class="btn btn-neutral float-right" title="Core ML Model" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>© Copyright 2021, Apple Inc..</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>