Models API

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="description" content="Keras documentation"> <meta name="author" content="Keras Team"> <link rel="shortcut icon" href="https://keras.io/img/favicon.ico"> <link rel="canonical" href="https://keras.io/api/models/" />  <meta property="og:title" content="Keras documentation: Models API"> <meta property="og:image" content="https://keras.io/img/logo-k-keras-wb.png"> <meta name="twitter:title" content="Keras documentation: Models API"> <meta name="twitter:image" content="https://keras.io/img/k-keras-social.png"> <meta name="twitter:card" content="summary"> <title>Models API</title>  <link href="/css/bootstrap.min.css" rel="stylesheet">  <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;600;700;800&display=swap" rel="stylesheet">  <link href="/css/docs.css" rel="stylesheet"> <link href="/css/monokai.css" rel="stylesheet">  <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-5DNGF4N'); </script> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-175165319-128', 'auto'); ga('send', 'pageview'); </script>  <script async defer src="https://buttons.github.io/buttons.js"></script> </head> <body>  <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5DNGF4N" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>  <div class='k-page'> <div class="k-nav" id="nav-menu"> <a href='/'><img src='/img/logo-small.png' class='logo-small' /></a> <div class="nav flex-column nav-pills" role="tablist" aria-orientation="vertical"> <a class="nav-link" href="/about/" role="tab" aria-selected="">About Keras</a> <a class="nav-link" href="/getting_started/" role="tab" aria-selected="">Getting started</a> <a class="nav-link" href="/guides/" role="tab" aria-selected="">Developer guides</a> <a class="nav-link active" href="/api/" role="tab" aria-selected="">Keras 3 API documentation</a> <a class="nav-sublink active" href="/api/models/">Models API</a> <a class="nav-sublink2" href="/api/models/model/">The Model class</a> <a class="nav-sublink2" href="/api/models/sequential/">The Sequential class</a> <a class="nav-sublink2" href="/api/models/model_training_apis/">Model training APIs</a> <a class="nav-sublink2" href="/api/models/model_saving_apis/">Saving & serialization</a> <a class="nav-sublink" href="/api/layers/">Layers API</a> <a class="nav-sublink" href="/api/callbacks/">Callbacks API</a> <a class="nav-sublink" href="/api/ops/">Ops API</a> <a class="nav-sublink" href="/api/optimizers/">Optimizers</a> <a class="nav-sublink" href="/api/metrics/">Metrics</a> <a class="nav-sublink" href="/api/losses/">Losses</a> <a class="nav-sublink" href="/api/data_loading/">Data loading</a> <a class="nav-sublink" href="/api/datasets/">Built-in small datasets</a> <a class="nav-sublink" href="/api/applications/">Keras Applications</a> <a class="nav-sublink" href="/api/mixed_precision/">Mixed precision</a> <a class="nav-sublink" href="/api/distribution/">Multi-device distribution</a> <a class="nav-sublink" href="/api/random/">RNG API</a> <a class="nav-sublink" href="/api/utils/">Utilities</a> <a class="nav-sublink" href="/api/keras_tuner/">KerasTuner</a> <a class="nav-sublink" href="/api/keras_cv/">KerasCV</a> <a class="nav-sublink" href="/api/keras_nlp/">KerasNLP</a> <a class="nav-sublink" href="/api/keras_hub/">KerasHub</a> <a class="nav-link" href="/2.18/api/" role="tab" aria-selected="">Keras 2 API documentation</a> <a class="nav-link" href="/examples/" role="tab" aria-selected="">Code examples</a> <a class="nav-link" href="/keras_tuner/" role="tab" aria-selected="">KerasTuner: Hyperparameter Tuning</a> <a class="nav-link" href="/keras_hub/" role="tab" aria-selected="">KerasHub: Pretrained Models</a> <a class="nav-link" href="/keras_cv/" role="tab" aria-selected="">KerasCV: Computer Vision Workflows</a> <a class="nav-link" href="/keras_nlp/" role="tab" aria-selected="">KerasNLP: Natural Language Workflows</a> </div> </div> <div class='k-main'> <div class='k-main-top'> <script> function displayDropdownMenu() { e = document.getElementById("nav-menu"); if (e.style.display == "block") { e.style.display = "none"; } else { e.style.display = "block"; document.getElementById("dropdown-nav").style.display = "block"; } } function resetMobileUI() { if (window.innerWidth <= 840) { document.getElementById("nav-menu").style.display = "none"; document.getElementById("dropdown-nav").style.display = "block"; } else { document.getElementById("nav-menu").style.display = "block"; document.getElementById("dropdown-nav").style.display = "none"; } var navmenu = document.getElementById("nav-menu"); var menuheight = navmenu.clientHeight; var kmain = document.getElementById("k-main-id"); kmain.style.minHeight = (menuheight + 100) + 'px'; } window.onresize = resetMobileUI; window.addEventListener("load", (event) => { resetMobileUI() }); </script> <div id='dropdown-nav' onclick="displayDropdownMenu();"> <svg viewBox="-20 -20 120 120" width="60" height="60"> <rect width="100" height="20"></rect> <rect y="30" width="100" height="20"></rect> <rect y="60" width="100" height="20"></rect> </svg> </div> <form class="bd-search d-flex align-items-center k-search-form" id="search-form"> <input type="search" class="k-search-input" id="search-input" placeholder="Search Keras documentation..." aria-label="Search Keras documentation..." autocomplete="off"> <button class="k-search-btn"> <svg width="13" height="13" viewBox="0 0 13 13"><title>search</title><path d="m4.8495 7.8226c0.82666 0 1.5262-0.29146 2.0985-0.87438 0.57232-0.58292 0.86378-1.2877 0.87438-2.1144 0.010599-0.82666-0.28086-1.5262-0.87438-2.0985-0.59352-0.57232-1.293-0.86378-2.0985-0.87438-0.8055-0.010599-1.5103 0.28086-2.1144 0.87438-0.60414 0.59352-0.8956 1.293-0.87438 2.0985 0.021197 0.8055 0.31266 1.5103 0.87438 2.1144 0.56172 0.60414 1.2665 0.8956 2.1144 0.87438zm4.4695 0.2115 3.681 3.6819-1.259 1.284-3.6817-3.7 0.0019784-0.69479-0.090043-0.098846c-0.87973 0.76087-1.92 1.1413-3.1207 1.1413-1.3553 0-2.5025-0.46363-3.4417-1.3909s-1.4088-2.0686-1.4088-3.4239c0-1.3553 0.4696-2.4966 1.4088-3.4239 0.9392-0.92727 2.0864-1.3969 3.4417-1.4088 1.3553-0.011889 2.4906 0.45771 3.406 1.4088 0.9154 0.95107 1.379 2.0924 1.3909 3.4239 0 1.2126-0.38043 2.2588-1.1413 3.1385l0.098834 0.090049z"></path></svg> </button> </form> <script> var form = document.getElementById('search-form'); form.onsubmit = function(e) { e.preventDefault(); var query = document.getElementById('search-input').value; window.location.href = '/search.html?query=' + query; return False } </script> </div> <div class='k-main-inner' id='k-main-id'> <div class='k-location-slug'> <span class="k-location-slug-pointer">►</span> <a href='/api/'>Keras 3 API documentation</a> / Models API </div> <div class='k-content'> <h1 id="models-api">Models API</h1> <p>There are three ways to create Keras models:</p> <ul> <li>The <a href="/guides/sequential_model">Sequential model</a>, which is very straightforward (a simple list of layers), but is limited to single-input, single-output stacks of layers (as the name gives away).</li> <li>The <a href="/guides/functional_api">Functional API</a>, which is an easy-to-use, fully-featured API that supports arbitrary model architectures. For most people and most use cases, this is what you should be using. This is the Keras "industry strength" model.</li> <li><a href="/guides/making_new_layers_and_models_via_subclassing">Model subclassing</a>, where you implement everything from scratch on your own. Use this if you have complex, out-of-the-box research use cases.</li> </ul> <h2 id="models-api-overview">Models API overview</h2> <h3 id="the-model-class"><a href="/api/models/model/">The Model class</a></h3> <ul> <li><a href="/api/models/model/#model-class">Model class</a></li> <li><a href="/api/models/model/#summary-method">summary method</a></li> <li><a href="/api/models/model/#get_layer-method">get_layer method</a></li> </ul> <h3 id="the-sequential-class"><a href="/api/models/sequential/">The Sequential class</a></h3> <ul> <li><a href="/api/models/sequential/#sequential-class">Sequential class</a></li> <li><a href="/api/models/sequential/#add-method">add method</a></li> <li><a href="/api/models/sequential/#pop-method">pop method</a></li> </ul> <h3 id="model-training-apis"><a href="/api/models/model_training_apis/">Model training APIs</a></h3> <ul> <li><a href="/api/models/model_training_apis/#compile-method">compile method</a></li> <li><a href="/api/models/model_training_apis/#fit-method">fit method</a></li> <li><a href="/api/models/model_training_apis/#evaluate-method">evaluate method</a></li> <li><a href="/api/models/model_training_apis/#predict-method">predict method</a></li> <li><a href="/api/models/model_training_apis/#train_on_batch-method">train_on_batch method</a></li> <li><a href="/api/models/model_training_apis/#test_on_batch-method">test_on_batch method</a></li> <li><a href="/api/models/model_training_apis/#predict_on_batch-method">predict_on_batch method</a></li> </ul> <h3 id="saving-amp-serialization"><a href="/api/models/model_saving_apis/">Saving & serialization</a></h3> <ul> <li><a href="/api/models/model_saving_apis/model_saving_and_loading">Whole model saving & loading</a></li> <li><a href="/api/models/model_saving_apis/weights_saving_and_loading">Weights-only saving & loading</a></li> <li><a href="/api/models/model_saving_apis/model_config_serialization">Model config serialization</a></li> <li><a href="/api/models/model_saving_apis/export">Model export for inference</a></li> <li><a href="/api/models/model_saving_apis/serialization_utils">Serialization utilities</a></li> <li><a href="/api/models/model_saving_apis/keras_file_editor">Keras weights file editor</a></li> </ul> </div> <div class='k-outline'> <div class='k-outline-depth-1'> <a href='#models-api'>Models API</a> </div> <div class='k-outline-depth-2'> ◆ <a href='#models-api-overview'>Models API overview</a> </div> <div class='k-outline-depth-3'> <a href='#the-model-class'>The Model class</a> </div> <div class='k-outline-depth-3'> <a href='#the-sequential-class'>The Sequential class</a> </div> <div class='k-outline-depth-3'> <a href='#model-training-apis'>Model training APIs</a> </div> <div class='k-outline-depth-3'> <a href='#saving-amp-serialization'>Saving & serialization</a> </div> </div> </div> </div> </div> </body> <footer style="float: left; width: 100%; padding: 1em; border-top: solid 1px #bbb;"> <a href="https://policies.google.com/terms">Terms</a> | <a href="https://policies.google.com/privacy">Privacy</a> </footer> </html>

CINXE.COM

Models API