CINXE.COM

<!DOCTYPE html> <html lang="en" > <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <title>Ray Train: Scalable Model Training — Ray 2.39.0</title> <script data-cfasync="false"> document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; document.documentElement.dataset.theme = localStorage.getItem("theme") || "light"; </script>  <link href="../_static/styles/theme.css?digest=ac02cc09edc035673794" rel="stylesheet" /> <link href="../_static/styles/bootstrap.css?digest=ac02cc09edc035673794" rel="stylesheet" /> <link href="../_static/styles/pydata-sphinx-theme.css?digest=ac02cc09edc035673794" rel="stylesheet" /> <link href="../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=ac02cc09edc035673794" rel="stylesheet" /> <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" /> <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" /> <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" /> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" /> <link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" /> <link rel="stylesheet" type="text/css" href="../_static/autodoc_pydantic.css" /> <link rel="stylesheet" type="text/css" href="../_static/css/termynal.css?v=2fc3cb5e" /> <link rel="stylesheet" type="text/css" href="../_static/css/csat.css?v=c8f39c76" /> <link rel="stylesheet" type="text/css" href="../_static/css/assistant.css?v=d345c55e" /> <link rel="stylesheet" type="text/css" href="../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" /> <link rel="stylesheet" type="text/css" href="../_static/css/ray-train.css?v=88f795f0" /> <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=2df59da5" /> <link rel="stylesheet" type="text/css" href="../_static/docsearch.css?v=45fb5152" /> <link rel="stylesheet" type="text/css" href="../_static/pydata-docsearch-custom.css?v=7fb92720" />  <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=ac02cc09edc035673794" /> <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" /> <script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script> <script src="../_static/documentation_options.js?v=483c7cf6"></script> <script src="../_static/doctools.js?v=9a2dae69"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/clipboard.min.js?v=a7894cd8"></script> <script src="../_static/copybutton.js?v=9a29e97e"></script> <script defer="defer" src="../_static/js/termynal.js?v=67cfcf08"></script> <script defer="defer" src="../_static/js/custom.js?v=9e3b357f"></script> <script src="../_static/js/csat.js?v=8e649b1c"></script> <script defer="defer" src="../_static/js/assistant.js?v=73fdc522"></script> <script defer="defer" src="../_static/docsearch.js?v=77274085"></script> <script defer="defer" src="../_static/docsearch_config.js?v=d25523ed"></script> <script src="../_static/design-tabs.js?v=36754332"></script> <script>DOCUMENTATION_OPTIONS.pagename = 'train/train';</script> <script> DOCUMENTATION_OPTIONS.theme_version = '0.14.1'; DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://docs.ray.io/en/master/_static/versions.json'; DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'latest'; DOCUMENTATION_OPTIONS.show_version_warning_banner = false; </script> <link rel="canonical" href="https://docs.ray.io/en/latest/train/train.html" /> <link rel="icon" href="../_static/favicon.ico"/> <link rel="index" title="Index" href="../genindex.html" /> <link rel="next" title="Ray Train Overview" href="overview.html" /> <link rel="prev" title="Ray Data Internals" href="../data/data-internals.html" /> <link rel="preconnect" href="https://fonts.googleapis.com" /> <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin /> <link href="https://fonts.googleapis.com/css2?family=Inter:wght@100;200;300;400;500;600;700;900&family=Roboto:wght@400;500;700&display=swap" rel="stylesheet" /> <link rel="stylesheet" title="light" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github.min.css" disabled="disabled" /> <link rel="stylesheet" title="dark" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github-dark.min.css" disabled="disabled" /> <link href="https://cdn.jsdelivr.net/npm/remixicon@4.1.0/fonts/remixicon.css" rel="stylesheet" />  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>  <script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>  <script src="https://cdnjs.cloudflare.com/ajax/libs/dompurify/2.3.3/purify.min.js"></script>  <script src="https://deer.ray.io/script.js" data-site="WYYANYOS" defer></script>   <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-P8H6KQG'); </script>   <script> window.data = { copyIconSrc: "../_static/copy-button.svg" }; </script> <meta name="viewport" content="width=device-width, initial-scale=1"/> <meta name="docsearch:language" content="en"/> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="anyscale-ray" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/train/train.html" /><meta name="readthedocs-http-status" content="200" /></head> <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode=""> <a class="skip-link" href="#main-content">Skip to main content</a> <div id="pst-scroll-pixel-helper"></div> <button type="button" class="btn rounded-pill" id="pst-back-to-top"> <i class="fa-solid fa-arrow-up"></i> Back to top </button> <input type="checkbox" class="sidebar-toggle" name="__primary" id="__primary"/> <label class="overlay overlay-primary" for="__primary"></label> <input type="checkbox" class="sidebar-toggle" name="__secondary" id="__secondary"/> <label class="overlay overlay-secondary" for="__secondary"></label> <div class="search-button__wrapper"> <div class="search-button__overlay"></div> <div class="search-button__search-container"> <form class="bd-search d-flex align-items-center" action="../search.html" method="get"> <i class="fa-solid fa-magnifying-glass"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> </form></div> </div> <nav class="bd-header navbar navbar-expand-lg bd-navbar"> <div class="bd-header__inner bd-page-width"> <label class="sidebar-toggle primary-toggle" for="__primary"> <span class="fa-solid fa-bars"></span> </label> <div class=" navbar-header-items__start"> <div class="navbar-item"> <a class="navbar-brand logo" href="../index.html"> <svg id="svg" version="1.1" viewBox="0, 0, 400,200.13540961408262" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"> <g id="g1"> <path id="ray-text" d="m 102.875,36.782 c 0.16,0.041 0.423,0.041 0.583,0 0.161,-0.042 0.029,-0.077 -0.291,-0.077 -0.321,0 -0.452,0.035 -0.292,0.077 m 89.958,63.206 v 30.345 h 3.584 3.583 v -9.487 -9.487 l 9.958,-0.059 c 10.822,-0.064 10.056,-0.121 10.664,0.804 0.113,0.172 0.394,0.597 0.625,0.945 0.231,0.348 0.42,0.693 0.42,0.766 0,0.073 0.15,0.269 0.333,0.435 0.183,0.166 0.333,0.358 0.333,0.427 0,0.069 0.366,0.676 0.814,1.349 0.925,1.393 2.687,4.088 2.936,4.493 0.092,0.149 0.312,0.486 0.489,0.751 1.348,2.013 2.261,3.416 2.261,3.474 0,0.038 0.338,0.561 0.75,1.164 0.413,0.602 0.755,1.151 0.761,1.219 0.006,0.067 0.267,0.46 0.58,0.873 0.313,0.412 0.692,0.975 0.843,1.25 0.622,1.138 0.378,1.083 4.846,1.083 h 4.062 l -0.254,-0.458 c -0.139,-0.252 -0.677,-1.058 -1.196,-1.792 -1.001,-1.416 -1.194,-1.694 -5.308,-7.666 -1.452,-2.109 -2.684,-3.871 -2.737,-3.917 -0.053,-0.046 -0.172,-0.213 -0.263,-0.372 -0.326,-0.563 -2.842,-4.226 -3.541,-5.154 -0.969,-1.287 -1.025,-1.162 0.832,-1.838 0.726,-0.263 2.976,-1.446 3.305,-1.737 0.145,-0.128 0.319,-0.232 0.388,-0.232 0.287,0 2.659,-2.095 3.515,-3.105 3.686,-4.345 5.22,-10.506 4.352,-17.484 -0.442,-3.559 -1.381,-5.956 -3.555,-9.078 -0.491,-0.706 -3.235,-3.333 -3.481,-3.333 -0.128,0 -0.232,-0.062 -0.232,-0.136 0,-0.075 -0.319,-0.313 -0.708,-0.53 -0.39,-0.216 -0.746,-0.439 -0.792,-0.496 -0.077,-0.096 -1.012,-0.546 -2.532,-1.218 -1.038,-0.459 -3.173,-1.141 -4.051,-1.293 -0.459,-0.08 -1.359,-0.273 -2,-0.429 -1.04,-0.253 -2.711,-0.292 -15.375,-0.353 l -14.209,-0.07 v 30.346 m 80.935,-28.446 c -0.448,1.031 -1.004,2.287 -1.235,2.791 -0.396,0.861 -0.579,1.27 -1.363,3.038 -0.403,0.911 -1.14,2.528 -1.903,4.177 -0.33,0.714 -0.6,1.373 -0.6,1.464 0,0.092 -0.107,0.333 -0.238,0.536 -0.13,0.203 -0.661,1.344 -1.179,2.535 -0.519,1.192 -1.085,2.467 -1.258,2.834 -0.464,0.979 -1.328,2.9 -2.324,5.166 -1.025,2.334 -1.477,3.34 -1.759,3.917 -0.113,0.229 -1.423,3.154 -2.913,6.5 -1.49,3.346 -2.951,6.608 -3.248,7.25 -1.302,2.818 -8.248,18.378 -8.248,18.475 0,0.06 1.714,0.108 3.808,0.108 h 3.809 l 1.04,-2.375 c 0.573,-1.306 1.191,-2.712 1.374,-3.125 0.183,-0.412 0.483,-1.087 0.665,-1.5 0.183,-0.412 0.467,-1.05 0.63,-1.416 0.164,-0.367 0.656,-1.492 1.093,-2.5 0.437,-1.009 0.93,-2.134 1.097,-2.5 0.166,-0.367 0.399,-0.911 0.517,-1.209 l 0.215,-0.541 h 16.448 16.447 l 0.369,0.791 c 0.203,0.436 0.464,1.017 0.581,1.292 0.209,0.494 1.042,2.363 1.485,3.333 0.21,0.46 2.5,5.679 2.998,6.834 0.118,0.275 0.406,0.912 0.638,1.416 0.232,0.504 0.465,1.048 0.516,1.209 0.085,0.267 0.426,0.291 4.003,0.291 h 3.91 l -0.137,-0.458 c -0.122,-0.41 -1.026,-2.462 -2.331,-5.292 -0.254,-0.55 -1.531,-3.4 -2.838,-6.333 -1.307,-2.933 -2.618,-5.858 -2.913,-6.5 -0.412,-0.894 -5.399,-12.071 -8.292,-18.583 -0.183,-0.413 -0.473,-1.05 -0.644,-1.417 -0.324,-0.694 -1.063,-2.353 -1.56,-3.5 -0.159,-0.367 -0.427,-0.967 -0.595,-1.333 -0.867,-1.885 -2.251,-4.97 -2.916,-6.5 -0.195,-0.45 -0.423,-0.958 -1.421,-3.167 -0.166,-0.367 -0.502,-1.117 -0.747,-1.667 -0.63,-1.413 -1.07,-2.395 -1.419,-3.166 -0.652,-1.443 -0.97,-2.18 -1.059,-2.459 -0.086,-0.266 -0.421,-0.291 -3.891,-0.291 h -3.798 l -0.814,1.875 M 306.5,69.745 c 0,0.096 0.45,0.894 1.132,2.005 0.281,0.458 0.75,1.283 1.042,1.833 0.293,0.55 0.625,1.113 0.738,1.25 0.114,0.138 0.649,1.029 1.189,1.982 0.54,0.952 1.147,2.002 1.348,2.333 0.201,0.331 0.669,1.127 1.04,1.769 0.372,0.641 0.874,1.504 1.117,1.916 0.452,0.769 0.799,1.371 1.408,2.446 0.19,0.337 0.586,0.993 0.878,1.458 0.293,0.466 0.625,1.034 0.738,1.263 0.113,0.229 0.393,0.717 0.622,1.083 0.229,0.367 0.735,1.218 1.124,1.891 0.389,0.673 0.857,1.477 1.041,1.787 0.183,0.31 0.775,1.334 1.316,2.276 0.541,0.942 1.066,1.817 1.167,1.944 0.101,0.127 0.446,0.704 0.767,1.282 0.32,0.579 0.948,1.675 1.393,2.436 0.446,0.762 0.963,1.647 1.149,1.968 0.186,0.32 0.476,0.808 0.644,1.083 0.168,0.275 0.497,0.837 0.73,1.25 0.234,0.412 0.563,0.975 0.731,1.25 0.168,0.275 0.456,0.763 0.64,1.083 0.183,0.321 0.607,1.046 0.94,1.612 l 0.606,1.028 v 10.18 10.18 h 3.583 3.584 v -10.55 c 0,-6.074 0.064,-10.617 0.151,-10.708 0.083,-0.087 0.32,-0.458 0.528,-0.825 0.869,-1.535 1.109,-1.954 1.881,-3.277 1.098,-1.882 1.383,-2.373 1.773,-3.056 0.183,-0.321 0.473,-0.827 0.644,-1.125 0.171,-0.298 0.587,-1.029 0.926,-1.625 0.338,-0.596 0.683,-1.196 0.765,-1.334 0.428,-0.714 1.259,-2.124 1.424,-2.416 0.186,-0.329 0.612,-1.07 1.22,-2.125 0.172,-0.298 0.634,-1.104 1.027,-1.792 0.393,-0.687 0.815,-1.368 0.938,-1.513 0.122,-0.145 0.223,-0.389 0.223,-0.542 0,-0.153 0.061,-0.278 0.137,-0.278 0.075,0 0.302,-0.319 0.503,-0.709 0.202,-0.389 0.551,-1.008 0.775,-1.375 0.225,-0.366 0.551,-0.929 0.724,-1.25 0.63,-1.167 2.234,-3.927 2.52,-4.336 0.161,-0.23 0.547,-0.889 0.858,-1.462 0.312,-0.574 0.732,-1.323 0.935,-1.664 0.203,-0.342 0.561,-0.959 0.796,-1.371 0.234,-0.413 0.585,-1.013 0.779,-1.333 0.325,-0.538 0.934,-1.61 1.374,-2.417 0.1,-0.183 0.267,-0.446 0.371,-0.583 0.103,-0.138 0.425,-0.7 0.715,-1.25 0.29,-0.55 0.647,-1.171 0.793,-1.379 l 0.265,-0.378 -3.801,0.045 -3.801,0.045 -0.3,0.5 c -0.165,0.275 -0.455,0.762 -0.644,1.083 -0.189,0.321 -0.565,0.921 -0.835,1.334 -0.27,0.412 -0.569,0.9 -0.664,1.083 -0.096,0.183 -0.395,0.671 -0.665,1.083 -0.27,0.413 -0.645,1.013 -0.834,1.334 -0.189,0.32 -0.49,0.808 -0.668,1.083 -0.178,0.275 -0.479,0.762 -0.669,1.083 -0.19,0.321 -0.712,1.184 -1.159,1.917 -0.448,0.733 -1.086,1.783 -1.417,2.333 -0.332,0.55 -0.824,1.338 -1.093,1.75 -0.27,0.413 -0.542,0.863 -0.605,1 -0.064,0.138 -0.427,0.738 -0.807,1.334 -0.38,0.596 -0.834,1.308 -1.009,1.583 -0.175,0.275 -0.402,0.65 -0.503,0.833 -0.102,0.184 -0.696,1.159 -1.321,2.167 -0.625,1.008 -1.316,2.133 -1.536,2.5 -0.219,0.367 -0.584,0.967 -0.81,1.333 -0.226,0.367 -0.461,0.777 -0.523,0.911 -0.061,0.134 -0.42,0.696 -0.797,1.25 -0.378,0.553 -0.737,1.118 -0.799,1.256 -0.061,0.138 -0.3,0.55 -0.531,0.917 -0.23,0.366 -0.507,0.837 -0.615,1.046 -0.292,0.563 -0.932,-0.03 -1.58,-1.463 -0.063,-0.138 -0.27,-0.473 -0.461,-0.747 -0.39,-0.556 -0.504,-0.738 -1.098,-1.753 -0.559,-0.954 -0.693,-1.171 -1.084,-1.754 -0.183,-0.274 -0.422,-0.647 -0.531,-0.83 -0.109,-0.183 -0.695,-1.12 -1.302,-2.083 -0.607,-0.962 -1.193,-1.897 -1.302,-2.077 -0.534,-0.884 -1.693,-2.723 -1.97,-3.124 -0.171,-0.249 -0.311,-0.495 -0.311,-0.549 0,-0.053 -0.141,-0.3 -0.312,-0.548 C 323.21,84.6 322,82.674 322,82.582 c 0,-0.053 -0.139,-0.299 -0.309,-0.547 -0.761,-1.11 -1.663,-2.54 -1.81,-2.868 -0.061,-0.138 -0.435,-0.724 -0.83,-1.303 -0.395,-0.578 -0.718,-1.088 -0.718,-1.133 0,-0.044 -0.3,-0.532 -0.666,-1.084 C 317.3,75.095 317,74.611 317,74.571 c 0,-0.039 -0.356,-0.628 -0.792,-1.308 -0.435,-0.681 -1.12,-1.768 -1.522,-2.417 l -0.731,-1.179 h -3.727 c -2.051,0 -3.728,0.035 -3.728,0.078 m -86.75,7.023 c 3.486,0.433 8.055,2.022 8.389,2.917 0.03,0.081 0.138,0.148 0.239,0.148 0.278,0 2.413,2.27 2.792,2.969 0.184,0.338 0.399,0.727 0.48,0.865 2.258,3.865 1.774,11.495 -0.942,14.836 -0.206,0.254 -0.375,0.504 -0.375,0.556 0,0.13 -1.451,1.504 -2.196,2.079 -1.372,1.059 -4.274,2.252 -6.804,2.797 -1.265,0.272 -2.482,0.311 -11.375,0.359 L 200,104.348 V 90.424 76.5 l 8.792,-0.001 c 7.089,0 9.211,0.052 10.958,0.269 m 58.745,1.979 c 0.003,0.09 0.235,0.653 0.516,1.25 0.281,0.598 0.662,1.424 0.846,1.836 0.185,0.413 0.48,1.05 0.656,1.417 0.177,0.367 0.321,0.719 0.321,0.783 -10e-4,0.101 0.437,1.075 1.82,4.05 0.17,0.367 1.189,2.654 2.263,5.084 1.075,2.429 2.18,4.904 2.456,5.5 0.276,0.596 0.76,1.683 1.075,2.416 0.581,1.349 0.792,1.826 1.478,3.334 0.209,0.458 0.542,1.208 0.74,1.666 0.198,0.459 0.498,1.115 0.666,1.459 l 0.307,0.625 h -13.32 c -8.524,0 -13.319,-0.059 -13.319,-0.163 0,-0.089 0.164,-0.52 0.365,-0.958 0.622,-1.356 1.332,-2.938 1.572,-3.504 0.126,-0.298 0.337,-0.786 0.469,-1.084 0.131,-0.298 0.814,-1.854 1.517,-3.458 0.704,-1.604 1.411,-3.217 1.573,-3.583 0.161,-0.367 0.406,-0.93 0.544,-1.25 0.137,-0.321 0.794,-1.821 1.459,-3.334 1.615,-3.672 1.781,-4.049 2.154,-4.875 0.175,-0.389 0.674,-1.533 1.108,-2.541 0.937,-2.177 1.685,-3.833 2.006,-4.443 0.128,-0.243 0.233,-0.576 0.233,-0.74 0,-0.333 0.484,0.168 0.495,0.513" /> <path id="ray-logo" d="m 101.476,36.871 c -1.303,0.145 -3.55,0.666 -4.332,1.004 -2.044,0.884 -2.472,1.092 -3.144,1.529 -7.177,4.661 -9.961,13.497 -6.746,21.409 0.465,1.144 0.582,1.352 1.707,3.057 0.986,1.494 3.928,4.463 4.424,4.463 0.054,0 0.429,0.223 0.832,0.496 4.639,3.13 12.64,3.283 17.395,0.332 0.457,-0.284 22.892,21.99 22.486,22.327 -0.218,0.181 -0.803,1.491 -1.437,3.22 l -0.352,0.959 h -6.238 c -5.795,0 -6.238,-0.021 -6.238,-0.288 0,-0.977 -1.759,-4.418 -3.151,-6.165 -4.027,-5.051 -11.482,-7.68 -17.226,-6.075 -0.711,0.198 -1.405,0.361 -1.542,0.361 -0.745,0 -4.681,2.22 -5.914,3.336 -0.321,0.291 -0.792,0.706 -1.046,0.923 -0.855,0.728 -2.606,3.23 -3.29,4.701 -0.372,0.801 -0.749,1.587 -0.837,1.746 -0.088,0.159 -0.16,0.434 -0.16,0.611 0,0.888 0.287,0.85 -6.415,0.85 H 74.04 l -0.198,-0.542 c -0.108,-0.298 -0.347,-0.917 -0.531,-1.375 -0.183,-0.458 -0.358,-0.946 -0.389,-1.083 -0.087,-0.39 -1.399,-2.503 -2.064,-3.324 -2.725,-3.366 -5.769,-5.225 -10.441,-6.377 -3.309,-0.816 -10.96,0.695 -12.419,2.453 -0.113,0.136 -0.278,0.248 -0.367,0.248 -0.392,0 -4.298,3.657 -4.298,4.024 0,0.086 -0.131,0.297 -0.291,0.469 -2.793,2.998 -3.936,11.297 -2.141,15.549 0.844,1.999 1.072,2.472 1.583,3.291 0.314,0.504 0.634,0.942 0.711,0.972 0.076,0.031 0.138,0.154 0.138,0.274 0,0.246 2.689,3.043 3.334,3.468 0.229,0.151 0.716,0.486 1.083,0.744 6.843,4.811 18.162,3.018 23.001,-3.643 0.093,-0.128 0.412,-0.542 0.709,-0.922 0.297,-0.38 0.54,-0.747 0.54,-0.815 0,-0.069 0.224,-0.489 0.498,-0.935 0.275,-0.445 0.461,-0.81 0.414,-0.81 -0.046,0 0.104,-0.372 0.335,-0.827 0.231,-0.456 0.42,-0.94 0.42,-1.076 0,-0.136 0.087,-0.439 0.193,-0.672 l 0.194,-0.425 h 6.22 6.22 l 0.101,0.459 c 1.063,4.828 6.623,10.565 11.322,11.682 0.366,0.087 1.154,0.288 1.75,0.446 7.975,2.118 18.533,-4.211 20.101,-12.05 l 0.107,-0.537 h 6.217 6.217 l 0.352,0.959 c 0.642,1.751 1.22,3.04 1.447,3.228 0.178,0.148 -2.094,2.503 -10.941,11.344 l -11.165,11.158 -0.793,-0.404 c -1.29,-0.658 -1.561,-0.769 -2.959,-1.21 -5.239,-1.651 -12.178,-0.296 -16.032,3.131 -1.412,1.256 -2.907,2.908 -3.508,3.878 -4.539,7.323 -3.445,16.326 2.69,22.138 0.992,0.939 3.39,2.578 4.35,2.972 1.875,0.771 2.482,1.005 2.729,1.053 0.149,0.03 0.849,0.174 1.556,0.32 10.388,2.155 20.37,-6.164 20.38,-16.983 0.002,-3.118 -0.379,-4.767 -1.788,-7.728 l -0.505,-1.061 11.107,-11.106 11.107,-11.105 0.873,0.447 c 1.444,0.739 3.341,1.372 5.068,1.691 1.606,0.297 5.042,0.225 6.39,-0.134 0.595,-0.159 1.37,-0.358 1.72,-0.442 1.198,-0.288 4.129,-1.822 5.32,-2.786 9.711,-7.857 8.716,-22.425 -1.957,-28.665 -3.504,-2.048 -8.663,-2.872 -12.167,-1.942 -0.55,0.146 -1.262,0.327 -1.583,0.403 -0.614,0.144 -1.774,0.627 -2.958,1.232 l -0.709,0.362 -11.105,-11.105 -11.105,-11.106 0.289,-0.561 c 3.009,-5.83 2.687,-12.491 -0.861,-17.825 -0.257,-0.386 -0.543,-0.821 -0.634,-0.965 -1.398,-2.203 -6.344,-5.524 -9.084,-6.099 -3.096,-0.651 -4.424,-0.766 -6.357,-0.551 m 4.095,8.912 c 6.101,1.712 8.316,9.521 3.993,14.078 -6.028,6.355 -16.205,1.325 -14.858,-7.345 0.559,-3.597 3.168,-6.047 7.544,-7.084 0.546,-0.13 2.249,0.05 3.321,0.351 M 59.946,91.812 c 2.314,0.806 4.061,2.37 5.152,4.615 l 0.644,1.323 v 2.25 2.25 l -0.648,1.332 c -3.748,7.711 -14.726,6.286 -16.362,-2.124 -1.223,-6.284 5.142,-11.76 11.214,-9.646 M 105,91.512 c 7.468,1.695 9.27,11.549 2.87,15.694 -7.325,4.746 -16.184,-3.082 -12.434,-10.986 0.56,-1.179 2.473,-3.387 2.935,-3.387 0.102,0 0.312,-0.113 0.465,-0.252 1.043,-0.944 4.259,-1.502 6.164,-1.069 m 46.441,0.171 c 4.417,1.35 7.025,5.54 6.148,9.877 -0.306,1.514 -0.863,2.879 -1.336,3.271 -0.139,0.116 -0.253,0.306 -0.253,0.424 0,0.307 -1.541,1.65 -2.554,2.224 -7.406,4.199 -15.743,-3.631 -12.051,-11.318 0.752,-1.565 3.286,-3.994 4.167,-3.994 0.112,0 0.276,-0.069 0.363,-0.153 0.713,-0.687 3.754,-0.87 5.516,-0.331 m -44.774,46.358 c 8.432,4.162 5.806,16.556 -3.5,16.523 C 100.595,154.555 96,152.103 96,150.74 c 0,-0.11 -0.106,-0.287 -0.236,-0.395 -1.065,-0.884 -1.517,-5.232 -0.754,-7.262 1.796,-4.781 7.334,-7.176 11.657,-5.042" /> </g> </svg> </a></div> </div> <div class=" navbar-header-items"> <div class="me-auto navbar-header-items__center"> <div class="navbar-item"><nav class="navbar-nav"> <p class="sidebar-header-items__title" role="heading" aria-level="1" aria-label="Site Navigation"> Site Navigation </p> <div class="navbar-content docutils container"> <ul class="navbar-toplevel"> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../ray-overview/getting-started.html" title="Get Started"><span class="navbar-link-title">Get Started</span></a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../ray-overview/use-cases.html" title="Use Cases"><span class="navbar-link-title">Use Cases</span></a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../ray-overview/examples.html" title="Example Gallery"><span class="navbar-link-title">Example Gallery</span></a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../ray-overview/installation.html" title="Library"><span class="navbar-link-title">Library</span></a></p> <i class="fa-solid fa-chevron-down"></i></div> <div class="navbar-dropdown docutils container"> <ul class="navbar-sublevel"> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../ray-core/walkthrough.html" title="Ray Core"><span class="navbar-link-title">Ray Core</span>Scale general Python applications</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../data/data.html" title="Ray Data"><span class="navbar-link-title">Ray Data</span>Scale data ingest and preprocessing</a></p> </div> </li> <li class="active-link"><div class="ref-container docutils container"> <p><a class="reference internal" href="#" title="Ray Train"><span class="navbar-link-title">Ray Train</span>Scale machine learning training</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../tune/index.html" title="Ray Tune"><span class="navbar-link-title">Ray Tune</span>Scale hyperparameter tuning</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../serve/index.html" title="Ray Serve"><span class="navbar-link-title">Ray Serve</span>Scale model serving</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../rllib/index.html" title="Ray RLlib"><span class="navbar-link-title">Ray RLlib</span>Scale reinforcement learning</a></p> </div> </li> </ul> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../index.html" title="Docs"><span class="navbar-link-title">Docs</span></a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://discuss.ray.io" title="Resources"><span class="navbar-link-title">Resources</span></a></p> <i class="fa-solid fa-chevron-down"></i></div> <div class="navbar-dropdown docutils container"> <ul class="navbar-sublevel"> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://discuss.ray.io" title="Discussion Forum"><span class="navbar-link-title">Discussion Forum</span>Get your Ray questions answered</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://github.com/ray-project/ray-educational-materials" title="Training"><span class="navbar-link-title">Training</span>Hands-on learning</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://www.anyscale.com/blog" title="Blog"><span class="navbar-link-title">Blog</span>Updates, best practices, user-stories</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://www.anyscale.com/events" title="Events"><span class="navbar-link-title">Events</span>Webinars, meetups, office hours</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://www.anyscale.com/blog/how-ray-and-anyscale-make-it-easy-to-do-massive-scale-machine-learning-on" title="Success Stories"><span class="navbar-link-title">Success Stories</span>Real-world workload examples</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../ray-overview/ray-libraries.html" title="Ecosystem"><span class="navbar-link-title">Ecosystem</span>Libraries integrated with Ray</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://www.ray.io/community" title="Community"><span class="navbar-link-title">Community</span>Connect with us</a></p> </div> </li> </ul> </div> </li> </ul> </div> </nav></div> </div> <div class="navbar-header-items__end"> <div class="navbar-item navbar-persistent--container"> <div id="docsearch"></div> </div> <div class="navbar-item"> <script> document.write(` <div class="version-switcher__container dropdown"> <button id="versionswitcherbutton" type="button" role="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-bs-toggle="dropdown" aria-haspopup="listbox" aria-controls="versionswitcherlist" aria-label="Version switcher list"> Choose version  <span class="caret"></span> </button> <div id="versionswitcherlist" class="version-switcher__menu dropdown-menu list-group-flush py-0" role="listbox" aria-labelledby="versionswitcherbutton">  </div> </div> `); </script></div> <div class="navbar-item"><a id="try-anyscale-href" href="https://console.anyscale.com/?utm_source=ray_docs&utm_medium=docs&utm_campaign=navbar"> <div id="try-anyscale-text"> <span>Try Ray on Anyscale</span> </div> </a></div> </div> </div> <div class="navbar-persistent--mobile"><div id="docsearch"></div> </div> <label class="sidebar-toggle secondary-toggle" for="__secondary" tabindex="0"> <span class="fa-solid fa-outdent"></span> </label> </div> </nav> <div class="bd-container"> <div class="bd-container__inner bd-page-width"> <div class="bd-sidebar-primary bd-sidebar"> <div class="sidebar-header-items sidebar-primary__section"> <div class="sidebar-header-items__center"> <div class="navbar-item"><nav class="navbar-nav"> <p class="sidebar-header-items__title" role="heading" aria-level="1" aria-label="Site Navigation"> Site Navigation </p> <div class="navbar-content docutils container"> <ul class="navbar-toplevel"> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../ray-overview/getting-started.html" title="Get Started"><span class="navbar-link-title">Get Started</span></a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../ray-overview/use-cases.html" title="Use Cases"><span class="navbar-link-title">Use Cases</span></a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../ray-overview/examples.html" title="Example Gallery"><span class="navbar-link-title">Example Gallery</span></a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../ray-overview/installation.html" title="Library"><span class="navbar-link-title">Library</span></a></p> <i class="fa-solid fa-chevron-down"></i></div> <div class="navbar-dropdown docutils container"> <ul class="navbar-sublevel"> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../ray-core/walkthrough.html" title="Ray Core"><span class="navbar-link-title">Ray Core</span>Scale general Python applications</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../data/data.html" title="Ray Data"><span class="navbar-link-title">Ray Data</span>Scale data ingest and preprocessing</a></p> </div> </li> <li class="active-link"><div class="ref-container docutils container"> <p><a class="reference internal" href="#" title="Ray Train"><span class="navbar-link-title">Ray Train</span>Scale machine learning training</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../tune/index.html" title="Ray Tune"><span class="navbar-link-title">Ray Tune</span>Scale hyperparameter tuning</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../serve/index.html" title="Ray Serve"><span class="navbar-link-title">Ray Serve</span>Scale model serving</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../rllib/index.html" title="Ray RLlib"><span class="navbar-link-title">Ray RLlib</span>Scale reinforcement learning</a></p> </div> </li> </ul> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../index.html" title="Docs"><span class="navbar-link-title">Docs</span></a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://discuss.ray.io" title="Resources"><span class="navbar-link-title">Resources</span></a></p> <i class="fa-solid fa-chevron-down"></i></div> <div class="navbar-dropdown docutils container"> <ul class="navbar-sublevel"> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://discuss.ray.io" title="Discussion Forum"><span class="navbar-link-title">Discussion Forum</span>Get your Ray questions answered</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://github.com/ray-project/ray-educational-materials" title="Training"><span class="navbar-link-title">Training</span>Hands-on learning</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://www.anyscale.com/blog" title="Blog"><span class="navbar-link-title">Blog</span>Updates, best practices, user-stories</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://www.anyscale.com/events" title="Events"><span class="navbar-link-title">Events</span>Webinars, meetups, office hours</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://www.anyscale.com/blog/how-ray-and-anyscale-make-it-easy-to-do-massive-scale-machine-learning-on" title="Success Stories"><span class="navbar-link-title">Success Stories</span>Real-world workload examples</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference internal" href="../ray-overview/ray-libraries.html" title="Ecosystem"><span class="navbar-link-title">Ecosystem</span>Libraries integrated with Ray</a></p> </div> </li> <li><div class="ref-container docutils container"> <p><a class="reference external" href="https://www.ray.io/community" title="Community"><span class="navbar-link-title">Community</span>Connect with us</a></p> </div> </li> </ul> </div> </li> </ul> </div> </nav></div> </div> <div class="sidebar-header-items__end"> <div class="navbar-item"> <script> document.write(` <div class="version-switcher__container dropdown"> <button id="versionswitcherbutton" type="button" role="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-bs-toggle="dropdown" aria-haspopup="listbox" aria-controls="versionswitcherlist" aria-label="Version switcher list"> Choose version  <span class="caret"></span> </button> <div id="versionswitcherlist" class="version-switcher__menu dropdown-menu list-group-flush py-0" role="listbox" aria-labelledby="versionswitcherbutton">  </div> </div> `); </script></div> <div class="navbar-item"><a id="try-anyscale-href" href="https://console.anyscale.com/?utm_source=ray_docs&utm_medium=docs&utm_campaign=navbar"> <div id="try-anyscale-text"> <span>Try Ray on Anyscale</span> </div> </a></div> </div> </div> <div class="sidebar-primary-items__start sidebar-primary__section"> <div class="sidebar-primary-item"><nav id="main-sidebar" class="bd-docs-nav bd-links" aria-label="Section Navigation"> <div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav"> <li class="toctree-l1"><a class="reference internal" href="../ray-overview/index.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../ray-overview/getting-started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../ray-overview/installation.html">Installation</a></li> <li class="toctree-l1 has-children"><a class="reference internal" href="../ray-overview/use-cases.html">Use Cases</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../ray-air/getting-started.html">Ray for ML Infrastructure</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../ray-overview/examples.html">Example Gallery</a></li> <li class="toctree-l1"><a class="reference internal" href="../ray-overview/ray-libraries.html">Ecosystem</a></li> <li class="toctree-l1 has-children"><a class="reference internal" href="../ray-core/walkthrough.html">Ray Core</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../ray-core/key-concepts.html">Key Concepts</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../ray-core/user-guide.html">User Guides</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3 has-children"><a class="reference internal" href="../ray-core/tasks.html">Tasks</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../ray-core/tasks/nested-tasks.html">Nested Remote Functions</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/tasks/generators.html">Dynamic generators</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../ray-core/actors.html">Actors</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../ray-core/actors/named-actors.html">Named Actors</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/actors/terminating-actors.html">Terminating Actors</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/actors/async_api.html">AsyncIO / Concurrency for Actors</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/actors/concurrency_group_api.html">Limiting Concurrency Per-Method with Concurrency Groups</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/actors/actor-utils.html">Utility Classes</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/actors/out-of-band-communication.html">Out-of-band Communication</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/actors/task-orders.html">Actor Task Execution Order</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../ray-core/objects.html">Objects</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../ray-core/objects/serialization.html">Serialization</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/objects/object-spilling.html">Object Spilling</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/handling-dependencies.html">Environment Dependencies</a></li> <li class="toctree-l3 has-children"><a class="reference internal" href="../ray-core/scheduling/index.html">Scheduling</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-7"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../ray-core/scheduling/resources.html">Resources</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/scheduling/accelerators.html">Accelerator Support</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/scheduling/placement-group.html">Placement Groups</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/scheduling/memory-management.html">Memory Management</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/scheduling/ray-oom-prevention.html">Out-Of-Memory Prevention</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../ray-core/fault-tolerance.html">Fault Tolerance</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-8"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../ray-core/fault_tolerance/tasks.html">Task Fault Tolerance</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/fault_tolerance/actors.html">Actor Fault Tolerance</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/fault_tolerance/objects.html">Object Fault Tolerance</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/fault_tolerance/nodes.html">Node Fault Tolerance</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/fault_tolerance/gcs.html">GCS Fault Tolerance</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../ray-core/patterns/index.html">Design Patterns & Anti-patterns</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-9"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/nested-tasks.html">Pattern: Using nested tasks to achieve nested parallelism</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/generators.html">Pattern: Using generators to reduce heap memory usage</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/limit-pending-tasks.html">Pattern: Using ray.wait to limit the number of pending tasks</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/limit-running-tasks.html">Pattern: Using resources to limit the number of concurrently running tasks</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/concurrent-operations-async-actor.html">Pattern: Using asyncio to run actor methods concurrently</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/actor-sync.html">Pattern: Using an actor to synchronize other tasks and actors</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/tree-of-actors.html">Pattern: Using a supervisor actor to manage a tree of actors</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/pipelining.html">Pattern: Using pipelining to increase throughput</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/return-ray-put.html">Anti-pattern: Returning ray.put() ObjectRefs from a task harms performance and fault tolerance</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/ray-get-loop.html">Anti-pattern: Calling ray.get in a loop harms parallelism</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/unnecessary-ray-get.html">Anti-pattern: Calling ray.get unnecessarily harms performance</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/ray-get-submission-order.html">Anti-pattern: Processing results in submission order using ray.get increases runtime</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/ray-get-too-many-objects.html">Anti-pattern: Fetching too many objects at once with ray.get causes failure</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/too-fine-grained-tasks.html">Anti-pattern: Over-parallelizing with too fine-grained tasks harms speedup</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/redefine-task-actor-loop.html">Anti-pattern: Redefining the same remote function or class harms performance</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/pass-large-arg-by-value.html">Anti-pattern: Passing the same large argument by value repeatedly harms performance</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/closure-capture-large-objects.html">Anti-pattern: Closure capturing large objects harms performance</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/global-variables.html">Anti-pattern: Using global variables to share state between tasks and actors</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/patterns/out-of-band-object-ref-serialization.html">Anti-pattern: Serialize ray.ObjectRef out of band</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../ray-core/advanced-topics.html">Advanced Topics</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-10"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../ray-core/tips-for-first-time.html">Tips for first-time users</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/starting-ray.html">Starting Ray</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/ray-generator.html">Ray Generators</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/namespaces.html">Using Namespaces</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/cross-language.html">Cross-Language Programming</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/using-ray-with-jupyter.html">Working with Jupyter Notebooks & JupyterLab</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/ray-dag.html">Lazy Computation Graphs with the Ray DAG API</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/miscellaneous.html">Miscellaneous Topics</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/runtime_env_auth.html">Authenticating Remote URIs in runtime_env</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-core/user-spawn-processes.html">Lifetimes of a User-Spawn Process</a></li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../ray-core/examples/overview.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-11"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../ray-core/examples/automl_for_time_series.html">Simple AutoML for time series with Ray Core</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/examples/batch_prediction.html">Batch Prediction with Ray Core</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/examples/gentle_walkthrough.html">A Gentle Introduction to Ray Core by Example</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/examples/highly_parallel.html">Using Ray for Highly Parallelizable Tasks</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/examples/map_reduce.html">A Simple MapReduce Example with Ray Core</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/examples/monte_carlo_pi.html">Monte Carlo Estimation of 蟺</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/examples/plot_hyperparameter.html">Simple Parallel Model Selection</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/examples/plot_parameter_server.html">Parameter Server</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/examples/plot_pong_example.html">Learning to Play Pong</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/examples/web-crawler.html">Speed up your web crawler by parallelizing it with Ray</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../ray-core/api/index.html">Ray Core API</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-12"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../ray-core/api/core.html">Core API</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/api/scheduling.html">Scheduling API</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/api/runtime-env.html">Runtime Env API</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/api/utility.html">Utility</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/api/exceptions.html">Exceptions</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-core/api/cli.html">Ray Core CLI</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-observability/reference/cli.html">State CLI</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-observability/reference/api.html">State API</a></li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="../data/data.html">Ray Data</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-13"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../data/overview.html">Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="../data/quickstart.html">Quickstart</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../data/user-guide.html">User Guides</a><input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-14"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../data/loading-data.html">Loading Data</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/inspecting-data.html">Inspecting Data</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/transforming-data.html">Transforming Data</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/iterating-over-data.html">Iterating over Data</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/shuffling-data.html">Shuffling Data</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/saving-data.html">Saving Data</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/working-with-images.html">Working with Images</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/working-with-text.html">Working with Text</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/working-with-tensors.html">Working with Tensors / NumPy</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/working-with-pytorch.html">Working with PyTorch</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/monitoring-your-workload.html">Monitoring Your Workload</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/execution-configurations.html">Execution Configurations</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/batch_inference.html">End-to-end: Offline Batch Inference</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/performance-tips.html">Advanced: Performance Tips and Tuning</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/custom-datasource-example.html">Advanced: Read and Write Custom File Types</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../data/examples.html">Examples</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../data/api/api.html">Ray Data API</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-15"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../data/api/input_output.html">Input/Output</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/api/dataset.html">Dataset API</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/api/data_iterator.html">DataIterator API</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/api/execution_options.html">ExecutionOptions API</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/api/grouped_data.html">GroupedData API</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/api/data_context.html">Global configuration</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/api/preprocessor.html">Preprocessor</a></li> <li class="toctree-l3"><a class="reference internal" href="../data/api/from_other_data_libs.html">API Guide for Users from Other Data Libraries</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../data/data-internals.html">Ray Data Internals</a></li> </ul> </li> <li class="toctree-l1 has-children current-page"><a class="reference internal" href="../train/train.html">Ray Train</a><input checked="True" class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-16"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../train/overview.html">Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="../train/getting-started-pytorch.html">PyTorch Guide</a></li> <li class="toctree-l2"><a class="reference internal" href="../train/getting-started-pytorch-lightning.html">PyTorch Lightning Guide</a></li> <li class="toctree-l2"><a class="reference internal" href="../train/getting-started-transformers.html">Hugging Face Transformers Guide</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../train/more-frameworks.html">More Frameworks</a><input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-17"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../train/huggingface-accelerate.html">Hugging Face Accelerate Guide</a></li> <li class="toctree-l3"><a class="reference internal" href="../train/deepspeed.html">DeepSpeed Guide</a></li> <li class="toctree-l3"><a class="reference internal" href="../train/distributed-tensorflow-keras.html">TensorFlow and Keras Guide</a></li> <li class="toctree-l3"><a class="reference internal" href="../train/distributed-xgboost-lightgbm.html">XGBoost and LightGBM Guide</a></li> <li class="toctree-l3"><a class="reference internal" href="../train/horovod.html">Horovod Guide</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../train/user-guides.html">User Guides</a><input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-18"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../train/user-guides/data-loading-preprocessing.html">Data Loading and Preprocessing</a></li> <li class="toctree-l3"><a class="reference internal" href="../train/user-guides/using-gpus.html">Configuring Scale and GPUs</a></li> <li class="toctree-l3"><a class="reference internal" href="../train/user-guides/persistent-storage.html">Configuring Persistent Storage</a></li> <li class="toctree-l3"><a class="reference internal" href="../train/user-guides/monitoring-logging.html">Monitoring and Logging Metrics</a></li> <li class="toctree-l3"><a class="reference internal" href="../train/user-guides/checkpoints.html">Saving and Loading Checkpoints</a></li> <li class="toctree-l3"><a class="reference internal" href="../train/user-guides/experiment-tracking.html">Experiment Tracking</a></li> <li class="toctree-l3"><a class="reference internal" href="../train/user-guides/results.html">Inspecting Training Results</a></li> <li class="toctree-l3"><a class="reference internal" href="../train/user-guides/fault-tolerance.html">Handling Failures and Node Preemption</a></li> <li class="toctree-l3"><a class="reference internal" href="../train/user-guides/reproducibility.html">Reproducibility</a></li> <li class="toctree-l3"><a class="reference internal" href="../train/user-guides/hyperparameter-optimization.html">Hyperparameter Optimization</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../train/examples.html">Examples</a></li> <li class="toctree-l2"><a class="reference internal" href="../train/benchmarks.html">Benchmarks</a></li> <li class="toctree-l2"><a class="reference internal" href="../train/api/api.html">Ray Train API</a></li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="../tune/index.html">Ray Tune</a><input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-19"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../tune/getting-started.html">Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="../tune/key-concepts.html">Key Concepts</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../tune/tutorials/overview.html">User Guides</a><input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-20"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../tune/tutorials/tune-run.html">Running Basic Experiments</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/tutorials/tune-output.html">Logging and Outputs in Tune</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/tutorials/tune-resources.html">Setting Trial Resources</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/tutorials/tune-search-spaces.html">Using Search Spaces</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/tutorials/tune-stopping.html">How to Define Stopping Criteria for a Ray Tune Experiment</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/tutorials/tune-trial-checkpoints.html">How to Save and Load Trial Checkpoints</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/tutorials/tune-storage.html">How to Configure Persistent Storage in Ray Tune</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/tutorials/tune-fault-tolerance.html">How to Enable Fault Tolerance in Ray Tune</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/tutorials/tune-metrics.html">Using Callbacks and Metrics</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/tutorials/tune_get_data_in_and_out.html">Getting Data in and out of Tune</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/examples/tune_analyze_results.html">Analyzing Tune Experiment Results</a></li> <li class="toctree-l3 has-children"><a class="reference internal" href="../tune/examples/pbt_guide.html">A Guide to Population Based Training with Tune</a><input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-21"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/pbt_visualization/pbt_visualization.html">Visualizing and Understanding PBT</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="../tune/tutorials/tune-distributed.html">Deploying Tune in the Cloud</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/tutorials/tune-lifecycle.html">Tune Architecture</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/tutorials/tune-scalability.html">Scalability Benchmarks</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../tune/examples/index.html">Ray Tune Examples</a><input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-22"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3 has-children"><a class="reference internal" href="../tune/examples/ml-frameworks.html">Examples using Ray Tune with ML Frameworks</a><input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-23"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/tune_mnist_keras.html">Keras Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/tune-pytorch-cifar.html">PyTorch Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/tune-pytorch-lightning.html">PyTorch Lightning Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/pbt_ppo_example.html">Ray RLlib Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/tune-xgboost.html">XGBoost Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/lightgbm_example.html">LightGBM Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/horovod_simple.html">Horovod Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/pbt_transformers.html">Hugging Face Transformers Example</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../tune/examples/experiment-tracking.html">Tune Experiment Tracking Examples</a><input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-24"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/tune-wandb.html">Weights & Biases Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/tune-mlflow.html">MLflow Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/tune-aim.html">Aim Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/tune-comet.html">Comet Example</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../tune/examples/hpo-frameworks.html">Tune Hyperparameter Optimization Framework Examples</a><input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-25"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/ax_example.html">Ax Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/hyperopt_example.html">HyperOpt Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/bayesopt_example.html">Bayesopt Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/bohb_example.html">BOHB Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/nevergrad_example.html">Nevergrad Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../tune/examples/optuna_example.html">Optuna Example</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="../tune/examples/other-examples.html">Other Examples</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/examples/exercises.html">Exercises</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../tune/faq.html">Ray Tune FAQ</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../tune/api/api.html">Ray Tune API</a><input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-26"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../tune/api/execution.html">Tune Execution (tune.Tuner)</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/result_grid.html">Tune Experiment Results (tune.ResultGrid)</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/trainable.html">Training in Tune (tune.Trainable, train.report)</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/search_space.html">Tune Search Space API</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/suggestion.html">Tune Search Algorithms (tune.search)</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/schedulers.html">Tune Trial Schedulers (tune.schedulers)</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/stoppers.html">Tune Stopping Mechanisms (tune.stopper)</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/reporters.html">Tune Console Output (Reporters)</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/syncing.html">Syncing in Tune (train.SyncConfig)</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/logging.html">Tune Loggers (tune.logger)</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/callbacks.html">Tune Callbacks (tune.Callback)</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/env.html">Environment variables used by Ray Tune</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/integration.html">External library integrations for Ray Tune</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/internals.html">Tune Internals</a></li> <li class="toctree-l3"><a class="reference internal" href="../tune/api/cli.html">Tune CLI (Experimental)</a></li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="../serve/index.html">Ray Serve</a><input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-27"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../serve/getting_started.html">Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="../serve/key-concepts.html">Key Concepts</a></li> <li class="toctree-l2"><a class="reference internal" href="../serve/develop-and-deploy.html">Develop and Deploy an ML Application</a></li> <li class="toctree-l2"><a class="reference internal" href="../serve/model_composition.html">Deploy Compositions of Models</a></li> <li class="toctree-l2"><a class="reference internal" href="../serve/multi-app.html">Deploy Multiple Applications</a></li> <li class="toctree-l2"><a class="reference internal" href="../serve/model-multiplexing.html">Model Multiplexing</a></li> <li class="toctree-l2"><a class="reference internal" href="../serve/configure-serve-deployment.html">Configure Ray Serve deployments</a></li> <li class="toctree-l2"><a class="reference internal" href="../serve/http-guide.html">Set Up FastAPI and HTTP</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../serve/production-guide/index.html">Production Guide</a><input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-28"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../serve/production-guide/config.html">Serve Config Files</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/production-guide/kubernetes.html">Deploy on Kubernetes</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/production-guide/docker.html">Custom Docker Images</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/production-guide/fault-tolerance.html">Add End-to-End Fault Tolerance</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/production-guide/handling-dependencies.html">Handle Dependencies</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/production-guide/best-practices.html">Best practices in production</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../serve/monitoring.html">Monitor Your Application</a></li> <li class="toctree-l2"><a class="reference internal" href="../serve/resource-allocation.html">Resource Allocation</a></li> <li class="toctree-l2"><a class="reference internal" href="../serve/autoscaling-guide.html">Ray Serve Autoscaling</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../serve/advanced-guides/index.html">Advanced Guides</a><input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-29"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../serve/advanced-guides/app-builder-guide.html">Pass Arguments to Applications</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/advanced-guides/advanced-autoscaling.html">Advanced Ray Serve Autoscaling</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/advanced-guides/performance.html">Performance Tuning</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/advanced-guides/dyn-req-batch.html">Dynamic Request Batching</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/advanced-guides/inplace-updates.html">Updating Applications In-Place</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/advanced-guides/dev-workflow.html">Development Workflow</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/advanced-guides/grpc-guide.html">Set Up a gRPC Service</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/advanced-guides/managing-java-deployments.html">Experimental Java API</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/advanced-guides/deploy-vm.html">Deploy on VM</a></li> <li class="toctree-l3"><a class="reference internal" href="../serve/advanced-guides/multi-app-container.html">Run Multiple Applications in Different Containers</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../serve/architecture.html">Architecture</a></li> <li class="toctree-l2"><a class="reference internal" href="../serve/examples.html">Examples</a></li> <li class="toctree-l2"><a class="reference internal" href="../serve/api/index.html">Ray Serve API</a></li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="../rllib/index.html">Ray RLlib</a><input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-30"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../rllib/rllib-training.html">Getting Started with RLlib</a></li> <li class="toctree-l2"><a class="reference internal" href="../rllib/key-concepts.html">Key Concepts</a></li> <li class="toctree-l2"><a class="reference internal" href="../rllib/rllib-env.html">Environments</a></li> <li class="toctree-l2"><a class="reference internal" href="../rllib/rllib-algorithms.html">Algorithms</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../rllib/user-guides.html">User Guides</a><input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-31"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../rllib/rllib-advanced-api.html">Advanced Python APIs</a></li> <li class="toctree-l3"><a class="reference internal" href="../rllib/rllib-models.html">Models, Preprocessors, and Action Distributions</a></li> <li class="toctree-l3"><a class="reference internal" href="../rllib/rllib-saving-and-loading-algos-and-policies.html">Saving and Loading your RL Algorithms and Policies</a></li> <li class="toctree-l3"><a class="reference internal" href="../rllib/rllib-concepts.html">How To Customize Policies</a></li> <li class="toctree-l3"><a class="reference internal" href="../rllib/single-agent-episode.html">Episodes</a></li> <li class="toctree-l3"><a class="reference internal" href="../rllib/rllib-replay-buffers.html">Replay Buffers</a></li> <li class="toctree-l3"><a class="reference internal" href="../rllib/rllib-offline.html">Working With Offline Data</a></li> <li class="toctree-l3"><a class="reference internal" href="../rllib/rllib-catalogs.html">Catalog (Alpha)</a></li> <li class="toctree-l3"><a class="reference internal" href="../rllib/rllib-rlmodule.html">RL Modules (Alpha)</a></li> <li class="toctree-l3"><a class="reference internal" href="../rllib/rllib-learner.html">Learner (Alpha)</a></li> <li class="toctree-l3"><a class="reference internal" href="../rllib/rllib-torch2x.html">Using RLlib with torch 2.x compile</a></li> <li class="toctree-l3"><a class="reference internal" href="../rllib/rllib-fault-tolerance.html">Fault Tolerance And Elastic Training</a></li> <li class="toctree-l3"><a class="reference internal" href="../rllib/rllib-dev.html">Install RLlib for Development</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../rllib/rllib-examples.html">Examples</a></li> <li class="toctree-l2"><a class="reference internal" href="../rllib/rllib-new-api-stack.html">RLlib鈥檚 new API stack</a></li> <li class="toctree-l2"><a class="reference internal" href="../rllib/new-api-stack-migration-guide.html">New API stack migration guide</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../rllib/package_ref/index.html">Ray RLlib API</a><input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-32"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3 has-children"><a class="reference internal" href="../rllib/package_ref/algorithm.html">Algorithms</a><input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-33"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.copy.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.copy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.validate.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.validate</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.freeze.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.freeze</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.build.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.build</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.build_learner_group.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.build_learner_group</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.build_learner.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.build_learner</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.callbacks.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.callbacks</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.debugging.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.debugging</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.environment.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.environment</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.evaluation.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.evaluation</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.experimental.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.experimental</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.fault_tolerance.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.fault_tolerance</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.framework.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.framework</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.multi_agent.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.multi_agent</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.offline_data.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.offline_data</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.python_environment.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.python_environment</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.reporting.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.reporting</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.resources.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.resources</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.rl_module.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.rl_module</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.rollouts.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.rollouts</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.training.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.training</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.get_default_learner_class.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.get_default_learner_class</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.get_default_rl_module_spec.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.get_default_rl_module_spec</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.get_evaluation_config_object.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.get_evaluation_config_object</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.get_multi_rl_module_spec.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.get_multi_rl_module_spec</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.get_multi_agent_setup.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.get_multi_agent_setup</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.get_rollout_fragment_length.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.get_rollout_fragment_length</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.validate_train_batch_size_vs_rollout_fragment_length.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.validate_train_batch_size_vs_rollout_fragment_length</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.html">ray.rllib.algorithms.algorithm.Algorithm</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.setup.html">ray.rllib.algorithms.algorithm.Algorithm.setup</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.get_default_config.html">ray.rllib.algorithms.algorithm.Algorithm.get_default_config</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.compute_actions.html">ray.rllib.algorithms.algorithm.Algorithm.compute_actions</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.compute_single_action.html">ray.rllib.algorithms.algorithm.Algorithm.compute_single_action</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.evaluate.html">ray.rllib.algorithms.algorithm.Algorithm.evaluate</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.from_checkpoint.html">ray.rllib.algorithms.algorithm.Algorithm.from_checkpoint</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.from_state.html">ray.rllib.algorithms.algorithm.Algorithm.from_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.get_weights.html">ray.rllib.algorithms.algorithm.Algorithm.get_weights</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.set_weights.html">ray.rllib.algorithms.algorithm.Algorithm.set_weights</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.export_model.html">ray.rllib.algorithms.algorithm.Algorithm.export_model</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.export_policy_checkpoint.html">ray.rllib.algorithms.algorithm.Algorithm.export_policy_checkpoint</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.export_policy_model.html">ray.rllib.algorithms.algorithm.Algorithm.export_policy_model</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.restore.html">ray.rllib.algorithms.algorithm.Algorithm.restore</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.restore_workers.html">ray.rllib.algorithms.algorithm.Algorithm.restore_workers</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.save.html">ray.rllib.algorithms.algorithm.Algorithm.save</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.save_checkpoint.html">ray.rllib.algorithms.algorithm.Algorithm.save_checkpoint</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.train.html">ray.rllib.algorithms.algorithm.Algorithm.train</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.training_step.html">ray.rllib.algorithms.algorithm.Algorithm.training_step</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.add_policy.html">ray.rllib.algorithms.algorithm.Algorithm.add_policy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm.Algorithm.remove_policy.html">ray.rllib.algorithms.algorithm.Algorithm.remove_policy</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../rllib/package_ref/env.html">Environments</a><input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-34"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/env/base_env.html">BaseEnv API</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/env/multi_agent_env.html">MultiAgentEnv API</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/env/vector_env.html">VectorEnv API</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/env/external_env.html">ExternalEnv API</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/env/single_agent_episode.html">SingleAgentEpisode API</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../rllib/package_ref/policy.html">Policy API</a><input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-35"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.policy.Policy.html">ray.rllib.policy.policy.Policy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.html">ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.torch_policy_v2.TorchPolicyV2.html">ray.rllib.policy.torch_policy_v2.TorchPolicyV2</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.torch_policy_v2.TorchPolicyV2.make_model.html">ray.rllib.policy.torch_policy_v2.TorchPolicyV2.make_model</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.torch_policy_v2.TorchPolicyV2.make_model_and_action_dist.html">ray.rllib.policy.torch_policy_v2.TorchPolicyV2.make_model_and_action_dist</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.make_model.html">ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.make_model</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.policy.Policy.compute_actions.html">ray.rllib.policy.policy.Policy.compute_actions</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.policy.Policy.compute_actions_from_input_dict.html">ray.rllib.policy.policy.Policy.compute_actions_from_input_dict</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.policy.Policy.compute_single_action.html">ray.rllib.policy.policy.Policy.compute_single_action</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.torch_policy_v2.TorchPolicyV2.action_sampler_fn.html">ray.rllib.policy.torch_policy_v2.TorchPolicyV2.action_sampler_fn</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.torch_policy_v2.TorchPolicyV2.action_distribution_fn.html">ray.rllib.policy.torch_policy_v2.TorchPolicyV2.action_distribution_fn</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.torch_policy_v2.TorchPolicyV2.extra_action_out.html">ray.rllib.policy.torch_policy_v2.TorchPolicyV2.extra_action_out</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.action_sampler_fn.html">ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.action_sampler_fn</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.action_distribution_fn.html">ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.action_distribution_fn</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.extra_action_out_fn.html">ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.extra_action_out_fn</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.compute_gradients.html">ray.rllib.policy.Policy.compute_gradients</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.apply_gradients.html">ray.rllib.policy.Policy.apply_gradients</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.torch_policy_v2.TorchPolicyV2.extra_compute_grad_fetches.html">ray.rllib.policy.torch_policy_v2.TorchPolicyV2.extra_compute_grad_fetches</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.torch_policy_v2.TorchPolicyV2.extra_grad_process.html">ray.rllib.policy.torch_policy_v2.TorchPolicyV2.extra_grad_process</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.grad_stats_fn.html">ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.grad_stats_fn</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.compute_gradients_fn.html">ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.compute_gradients_fn</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.apply_gradients_fn.html">ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.apply_gradients_fn</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.extra_learn_fetches_fn.html">ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.extra_learn_fetches_fn</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.learn_on_batch.html">ray.rllib.policy.Policy.learn_on_batch</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.load_batch_into_buffer.html">ray.rllib.policy.Policy.load_batch_into_buffer</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.learn_on_loaded_batch.html">ray.rllib.policy.Policy.learn_on_loaded_batch</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.learn_on_batch_from_replay_buffer.html">ray.rllib.policy.Policy.learn_on_batch_from_replay_buffer</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.get_num_samples_loaded_into_buffer.html">ray.rllib.policy.Policy.get_num_samples_loaded_into_buffer</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.loss.html">ray.rllib.policy.Policy.loss</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.compute_log_likelihoods.html">ray.rllib.policy.Policy.compute_log_likelihoods</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.on_global_var_update.html">ray.rllib.policy.Policy.on_global_var_update</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.postprocess_trajectory.html">ray.rllib.policy.Policy.postprocess_trajectory</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.torch_policy_v2.TorchPolicyV2.optimizer.html">ray.rllib.policy.torch_policy_v2.TorchPolicyV2.optimizer</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.torch_policy_v2.TorchPolicyV2.get_tower_stats.html">ray.rllib.policy.torch_policy_v2.TorchPolicyV2.get_tower_stats</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.optimizer.html">ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.optimizer</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.stats_fn.html">ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.stats_fn</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.from_checkpoint.html">ray.rllib.policy.Policy.from_checkpoint</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.export_checkpoint.html">ray.rllib.policy.Policy.export_checkpoint</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.export_model.html">ray.rllib.policy.Policy.export_model</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.from_state.html">ray.rllib.policy.Policy.from_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.get_weights.html">ray.rllib.policy.Policy.get_weights</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.set_weights.html">ray.rllib.policy.Policy.set_weights</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.get_state.html">ray.rllib.policy.Policy.get_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.set_state.html">ray.rllib.policy.Policy.set_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.import_model_from_h5.html">ray.rllib.policy.Policy.import_model_from_h5</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.Policy.get_initial_state.html">ray.rllib.Policy.get_initial_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.Policy.num_state_tensors.html">ray.rllib.Policy.num_state_tensors</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.Policy.is_recurrent.html">ray.rllib.Policy.is_recurrent</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.apply.html">ray.rllib.policy.Policy.apply</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.get_session.html">ray.rllib.policy.Policy.get_session</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.init_view_requirements.html">ray.rllib.policy.Policy.init_view_requirements</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.get_host.html">ray.rllib.policy.Policy.get_host</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.Policy.get_exploration_state.html">ray.rllib.policy.Policy.get_exploration_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.torch_policy_v2.TorchPolicyV2.get_batch_divisibility_req.html">ray.rllib.policy.torch_policy_v2.TorchPolicyV2.get_batch_divisibility_req</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.variables.html">ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.variables</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.get_batch_divisibility_req.html">ray.rllib.policy.eager_tf_policy_v2.EagerTFPolicyV2.get_batch_divisibility_req</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../rllib/package_ref/models.html">Model APIs</a><input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-36"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.models.modelv2.ModelV2.html">ray.rllib.models.modelv2.ModelV2</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.models.torch.torch_modelv2.TorchModelV2.html">ray.rllib.models.torch.torch_modelv2.TorchModelV2</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.models.tf.tf_modelv2.TFModelV2.html">ray.rllib.models.tf.tf_modelv2.TFModelV2</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.models.modelv2.ModelV2.forward.html">ray.rllib.models.modelv2.ModelV2.forward</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.models.modelv2.ModelV2.value_function.html">ray.rllib.models.modelv2.ModelV2.value_function</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.models.modelv2.ModelV2.last_output.html">ray.rllib.models.modelv2.ModelV2.last_output</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.models.modelv2.ModelV2.get_initial_state.html">ray.rllib.models.modelv2.ModelV2.get_initial_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.models.modelv2.ModelV2.is_time_major.html">ray.rllib.models.modelv2.ModelV2.is_time_major</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.models.modelv2.ModelV2.variables.html">ray.rllib.models.modelv2.ModelV2.variables</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.models.modelv2.ModelV2.trainable_variables.html">ray.rllib.models.modelv2.ModelV2.trainable_variables</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.models.distributions.Distribution.html">ray.rllib.models.distributions.Distribution</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.models.modelv2.ModelV2.custom_loss.html">ray.rllib.models.modelv2.ModelV2.custom_loss</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.models.modelv2.ModelV2.metrics.html">ray.rllib.models.modelv2.ModelV2.metrics</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../rllib/package_ref/catalogs.html">Catalog API</a><input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-37"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.models.catalog.Catalog.html">ray.rllib.core.models.catalog.Catalog</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.models.catalog.Catalog.build_encoder.html">ray.rllib.core.models.catalog.Catalog.build_encoder</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.models.catalog.Catalog.get_action_dist_cls.html">ray.rllib.core.models.catalog.Catalog.get_action_dist_cls</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.models.catalog.Catalog.get_tokenizer_config.html">ray.rllib.core.models.catalog.Catalog.get_tokenizer_config</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.models.catalog.Catalog.latent_dims.html">ray.rllib.core.models.catalog.Catalog.latent_dims</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.models.catalog.Catalog._determine_components_hook.html">ray.rllib.core.models.catalog.Catalog._determine_components_hook</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.models.catalog.Catalog._get_encoder_config.html">ray.rllib.core.models.catalog.Catalog._get_encoder_config</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.models.catalog.Catalog._get_dist_cls_from_action_space.html">ray.rllib.core.models.catalog.Catalog._get_dist_cls_from_action_space</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../rllib/package_ref/rl_modules.html">RLModule API</a><input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-38"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModuleSpec.html">ray.rllib.core.rl_module.rl_module.RLModuleSpec</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModuleSpec.build.html">ray.rllib.core.rl_module.rl_module.RLModuleSpec.build</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModuleSpec.get_rl_module_config.html">ray.rllib.core.rl_module.rl_module.RLModuleSpec.get_rl_module_config</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModuleConfig.html">ray.rllib.core.rl_module.rl_module.RLModuleConfig</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModuleConfig.to_dict.html">ray.rllib.core.rl_module.rl_module.RLModuleConfig.to_dict</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModuleConfig.from_dict.html">ray.rllib.core.rl_module.rl_module.RLModuleConfig.from_dict</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModuleConfig.get_catalog.html">ray.rllib.core.rl_module.rl_module.RLModuleConfig.get_catalog</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.multi_rl_module.MultiRLModuleSpec.html">ray.rllib.core.rl_module.multi_rl_module.MultiRLModuleSpec</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.multi_rl_module.MultiRLModuleSpec.build.html">ray.rllib.core.rl_module.multi_rl_module.MultiRLModuleSpec.build</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.multi_rl_module.MultiRLModuleSpec.get_multi_rl_module_config.html">ray.rllib.core.rl_module.multi_rl_module.MultiRLModuleSpec.get_multi_rl_module_config</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.html">ray.rllib.core.rl_module.rl_module.RLModule</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.as_multi_rl_module.html">ray.rllib.core.rl_module.rl_module.RLModule.as_multi_rl_module</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.forward_train.html">ray.rllib.core.rl_module.rl_module.RLModule.forward_train</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.forward_exploration.html">ray.rllib.core.rl_module.rl_module.RLModule.forward_exploration</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.forward_inference.html">ray.rllib.core.rl_module.rl_module.RLModule.forward_inference</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule._forward_train.html">ray.rllib.core.rl_module.rl_module.RLModule._forward_train</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule._forward_exploration.html">ray.rllib.core.rl_module.rl_module.RLModule._forward_exploration</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule._forward_inference.html">ray.rllib.core.rl_module.rl_module.RLModule._forward_inference</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.input_specs_inference.html">ray.rllib.core.rl_module.rl_module.RLModule.input_specs_inference</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.input_specs_exploration.html">ray.rllib.core.rl_module.rl_module.RLModule.input_specs_exploration</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.input_specs_train.html">ray.rllib.core.rl_module.rl_module.RLModule.input_specs_train</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.output_specs_inference.html">ray.rllib.core.rl_module.rl_module.RLModule.output_specs_inference</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.output_specs_exploration.html">ray.rllib.core.rl_module.rl_module.RLModule.output_specs_exploration</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.output_specs_train.html">ray.rllib.core.rl_module.rl_module.RLModule.output_specs_train</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.get_state.html">ray.rllib.core.rl_module.rl_module.RLModule.get_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.set_state.html">ray.rllib.core.rl_module.rl_module.RLModule.set_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.save_to_path.html">ray.rllib.core.rl_module.rl_module.RLModule.save_to_path</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.restore_from_path.html">ray.rllib.core.rl_module.rl_module.RLModule.restore_from_path</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.rl_module.RLModule.from_checkpoint.html">ray.rllib.core.rl_module.rl_module.RLModule.from_checkpoint</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.multi_rl_module.MultiRLModule.html">ray.rllib.core.rl_module.multi_rl_module.MultiRLModule</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.multi_rl_module.MultiRLModule.setup.html">ray.rllib.core.rl_module.multi_rl_module.MultiRLModule.setup</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.multi_rl_module.MultiRLModule.as_multi_rl_module.html">ray.rllib.core.rl_module.multi_rl_module.MultiRLModule.as_multi_rl_module</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.multi_rl_module.MultiRLModule.add_module.html">ray.rllib.core.rl_module.multi_rl_module.MultiRLModule.add_module</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.multi_rl_module.MultiRLModule.remove_module.html">ray.rllib.core.rl_module.multi_rl_module.MultiRLModule.remove_module</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.multi_rl_module.MultiRLModule.save_to_path.html">ray.rllib.core.rl_module.multi_rl_module.MultiRLModule.save_to_path</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.multi_rl_module.MultiRLModule.restore_from_path.html">ray.rllib.core.rl_module.multi_rl_module.MultiRLModule.restore_from_path</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../rllib/package_ref/learner.html">LearnerGroup API</a><input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-39"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.resources.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.resources</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.rl_module.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.rl_module</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.training.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.training</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.algorithms.algorithm_config.AlgorithmConfig.build_learner_group.html">ray.rllib.algorithms.algorithm_config.AlgorithmConfig.build_learner_group</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.learner.learner_group.LearnerGroup.html">ray.rllib.core.learner.learner_group.LearnerGroup</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../rllib/package_ref/evaluation.html">Sampling the Environment or offline data</a><input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-40"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.html">ray.rllib.evaluation.rollout_worker.RolloutWorker</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.add_policy.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.add_policy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.remove_policy.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.remove_policy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.get_policy.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.get_policy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.set_is_policy_to_train.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.set_is_policy_to_train</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.set_policy_mapping_fn.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.set_policy_mapping_fn</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.for_policy.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.for_policy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.foreach_policy.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.foreach_policy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.foreach_policy_to_train.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.foreach_policy_to_train</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.get_filters.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.get_filters</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.get_global_vars.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.get_global_vars</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.set_global_vars.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.set_global_vars</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.get_host.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.get_host</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.get_metrics.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.get_metrics</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.get_node_ip.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.get_node_ip</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.get_weights.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.get_weights</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.set_weights.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.set_weights</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.get_state.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.get_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.set_state.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.set_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.lock.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.lock</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.unlock.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.unlock</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.sample.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.sample</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.sample_with_count.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.sample_with_count</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.sample_and_learn.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.sample_and_learn</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.learn_on_batch.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.learn_on_batch</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.setup_torch_data_parallel.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.setup_torch_data_parallel</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.compute_gradients.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.compute_gradients</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.apply_gradients.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.apply_gradients</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.foreach_env.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.foreach_env</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.foreach_env_with_context.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.foreach_env_with_context</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.stop.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.stop</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.apply.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.apply</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.sync_filters.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.sync_filters</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.find_free_port.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.find_free_port</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.creation_args.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.creation_args</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.rollout_worker.RolloutWorker.assert_healthy.html">ray.rllib.evaluation.rollout_worker.RolloutWorker.assert_healthy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner.EnvRunner.html">ray.rllib.env.env_runner.EnvRunner</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.html">ray.rllib.env.env_runner_group.EnvRunnerGroup</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.stop.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.stop</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.reset.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.reset</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.add_workers.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.add_workers</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_worker.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_worker</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_worker_with_id.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_worker_with_id</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_worker_async.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_worker_async</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.fetch_ready_async_reqs.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.fetch_ready_async_reqs</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.num_in_flight_async_reqs.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.num_in_flight_async_reqs</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.local_worker.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.local_worker</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.remote_workers.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.remote_workers</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.num_healthy_remote_workers.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.num_healthy_remote_workers</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.num_healthy_workers.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.num_healthy_workers</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.num_remote_worker_restarts.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.num_remote_worker_restarts</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.probe_unhealthy_workers.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.probe_unhealthy_workers</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.add_policy.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.add_policy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_env.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_env</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_env_with_context.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_env_with_context</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_policy.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_policy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_policy_to_train.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.foreach_policy_to_train</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.env.env_runner_group.EnvRunnerGroup.sync_weights.html">ray.rllib.env.env_runner_group.EnvRunnerGroup.sync_weights</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.offline.input_reader.InputReader.html">ray.rllib.offline.input_reader.InputReader</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.offline.input_reader.InputReader.next.html">ray.rllib.offline.input_reader.InputReader.next</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.sampler.SamplerInput.html">ray.rllib.evaluation.sampler.SamplerInput</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.sampler.SamplerInput.get_data.html">ray.rllib.evaluation.sampler.SamplerInput.get_data</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.sampler.SamplerInput.get_extra_batches.html">ray.rllib.evaluation.sampler.SamplerInput.get_extra_batches</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.sampler.SamplerInput.get_metrics.html">ray.rllib.evaluation.sampler.SamplerInput.get_metrics</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.evaluation.sampler.SyncSampler.html">ray.rllib.evaluation.sampler.SyncSampler</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.offline.json_reader.JsonReader.html">ray.rllib.offline.json_reader.JsonReader</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.offline.json_reader.JsonReader.read_all_files.html">ray.rllib.offline.json_reader.JsonReader.read_all_files</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.offline.mixed_input.MixedInput.html">ray.rllib.offline.mixed_input.MixedInput</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.offline.d4rl_reader.D4RLReader.html">ray.rllib.offline.d4rl_reader.D4RLReader</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.offline.io_context.IOContext.html">ray.rllib.offline.io_context.IOContext</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.offline.io_context.IOContext.default_sampler_input.html">ray.rllib.offline.io_context.IOContext.default_sampler_input</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.policy_map.PolicyMap.html">ray.rllib.policy.policy_map.PolicyMap</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.policy_map.PolicyMap.items.html">ray.rllib.policy.policy_map.PolicyMap.items</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.policy_map.PolicyMap.keys.html">ray.rllib.policy.policy_map.PolicyMap.keys</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.policy_map.PolicyMap.values.html">ray.rllib.policy.policy_map.PolicyMap.values</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.html">ray.rllib.policy.sample_batch.SampleBatch</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.set_get_interceptor.html">ray.rllib.policy.sample_batch.SampleBatch.set_get_interceptor</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.is_training.html">ray.rllib.policy.sample_batch.SampleBatch.is_training</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.set_training.html">ray.rllib.policy.sample_batch.SampleBatch.set_training</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.as_multi_agent.html">ray.rllib.policy.sample_batch.SampleBatch.as_multi_agent</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.get.html">ray.rllib.policy.sample_batch.SampleBatch.get</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.to_device.html">ray.rllib.policy.sample_batch.SampleBatch.to_device</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.right_zero_pad.html">ray.rllib.policy.sample_batch.SampleBatch.right_zero_pad</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.slice.html">ray.rllib.policy.sample_batch.SampleBatch.slice</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.split_by_episode.html">ray.rllib.policy.sample_batch.SampleBatch.split_by_episode</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.shuffle.html">ray.rllib.policy.sample_batch.SampleBatch.shuffle</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.columns.html">ray.rllib.policy.sample_batch.SampleBatch.columns</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.rows.html">ray.rllib.policy.sample_batch.SampleBatch.rows</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.copy.html">ray.rllib.policy.sample_batch.SampleBatch.copy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.is_single_trajectory.html">ray.rllib.policy.sample_batch.SampleBatch.is_single_trajectory</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.is_terminated_or_truncated.html">ray.rllib.policy.sample_batch.SampleBatch.is_terminated_or_truncated</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.env_steps.html">ray.rllib.policy.sample_batch.SampleBatch.env_steps</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.SampleBatch.agent_steps.html">ray.rllib.policy.sample_batch.SampleBatch.agent_steps</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.MultiAgentBatch.html">ray.rllib.policy.sample_batch.MultiAgentBatch</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.MultiAgentBatch.env_steps.html">ray.rllib.policy.sample_batch.MultiAgentBatch.env_steps</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.policy.sample_batch.MultiAgentBatch.agent_steps.html">ray.rllib.policy.sample_batch.MultiAgentBatch.agent_steps</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../rllib/package_ref/replay-buffers.html">Replay Buffer API</a><input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-41"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.replay_buffers.replay_buffer.StorageUnit.html">ray.rllib.utils.replay_buffers.replay_buffer.StorageUnit</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.replay_buffers.replay_buffer.ReplayBuffer.html">ray.rllib.utils.replay_buffers.replay_buffer.ReplayBuffer</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer.html">ray.rllib.utils.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.replay_buffers.reservoir_replay_buffer.ReservoirReplayBuffer.html">ray.rllib.utils.replay_buffers.reservoir_replay_buffer.ReservoirReplayBuffer</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.replay_buffers.replay_buffer.ReplayBuffer.sample.html">ray.rllib.utils.replay_buffers.replay_buffer.ReplayBuffer.sample</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.replay_buffers.replay_buffer.ReplayBuffer.add.html">ray.rllib.utils.replay_buffers.replay_buffer.ReplayBuffer.add</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.replay_buffers.replay_buffer.ReplayBuffer.get_state.html">ray.rllib.utils.replay_buffers.replay_buffer.ReplayBuffer.get_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.replay_buffers.replay_buffer.ReplayBuffer.set_state.html">ray.rllib.utils.replay_buffers.replay_buffer.ReplayBuffer.set_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.replay_buffers.multi_agent_replay_buffer.MultiAgentReplayBuffer.html">ray.rllib.utils.replay_buffers.multi_agent_replay_buffer.MultiAgentReplayBuffer</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.replay_buffers.multi_agent_prioritized_replay_buffer.MultiAgentPrioritizedReplayBuffer.html">ray.rllib.utils.replay_buffers.multi_agent_prioritized_replay_buffer.MultiAgentPrioritizedReplayBuffer</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.replay_buffers.utils.update_priorities_in_replay_buffer.html">ray.rllib.utils.replay_buffers.utils.update_priorities_in_replay_buffer</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.replay_buffers.utils.sample_min_n_steps_from_buffer.html">ray.rllib.utils.replay_buffers.utils.sample_min_n_steps_from_buffer</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../rllib/package_ref/utils.html">RLlib Utilities</a><input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-42"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.exploration.Exploration.html">ray.rllib.utils.exploration.exploration.Exploration</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.random.Random.html">ray.rllib.utils.exploration.random.Random</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.stochastic_sampling.StochasticSampling.html">ray.rllib.utils.exploration.stochastic_sampling.StochasticSampling</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.epsilon_greedy.EpsilonGreedy.html">ray.rllib.utils.exploration.epsilon_greedy.EpsilonGreedy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.gaussian_noise.GaussianNoise.html">ray.rllib.utils.exploration.gaussian_noise.GaussianNoise</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.ornstein_uhlenbeck_noise.OrnsteinUhlenbeckNoise.html">ray.rllib.utils.exploration.ornstein_uhlenbeck_noise.OrnsteinUhlenbeckNoise</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.random_encoder.RE3.html">ray.rllib.utils.exploration.random_encoder.RE3</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.curiosity.Curiosity.html">ray.rllib.utils.exploration.curiosity.Curiosity</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.parameter_noise.ParameterNoise.html">ray.rllib.utils.exploration.parameter_noise.ParameterNoise</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.exploration.Exploration.get_exploration_action.html">ray.rllib.utils.exploration.exploration.Exploration.get_exploration_action</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.exploration.Exploration.before_compute_actions.html">ray.rllib.utils.exploration.exploration.Exploration.before_compute_actions</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.exploration.Exploration.on_episode_start.html">ray.rllib.utils.exploration.exploration.Exploration.on_episode_start</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.exploration.Exploration.on_episode_end.html">ray.rllib.utils.exploration.exploration.Exploration.on_episode_end</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.exploration.Exploration.postprocess_trajectory.html">ray.rllib.utils.exploration.exploration.Exploration.postprocess_trajectory</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.exploration.Exploration.get_state.html">ray.rllib.utils.exploration.exploration.Exploration.get_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.exploration.exploration.Exploration.set_state.html">ray.rllib.utils.exploration.exploration.Exploration.set_state</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.schedules.schedule.Schedule.html">ray.rllib.utils.schedules.schedule.Schedule</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.schedules.constant_schedule.ConstantSchedule.html">ray.rllib.utils.schedules.constant_schedule.ConstantSchedule</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.schedules.linear_schedule.LinearSchedule.html">ray.rllib.utils.schedules.linear_schedule.LinearSchedule</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.schedules.piecewise_schedule.PiecewiseSchedule.html">ray.rllib.utils.schedules.piecewise_schedule.PiecewiseSchedule</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.schedules.exponential_schedule.ExponentialSchedule.html">ray.rllib.utils.schedules.exponential_schedule.ExponentialSchedule</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.schedules.polynomial_schedule.PolynomialSchedule.html">ray.rllib.utils.schedules.polynomial_schedule.PolynomialSchedule</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.schedules.schedule.Schedule.value.html">ray.rllib.utils.schedules.schedule.Schedule.value</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.schedules.schedule.Schedule.__call__.html">ray.rllib.utils.schedules.schedule.Schedule.__call__</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.execution.train_ops.multi_gpu_train_one_step.html">ray.rllib.execution.train_ops.multi_gpu_train_one_step</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.execution.train_ops.train_one_step.html">ray.rllib.execution.train_ops.train_one_step</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.framework.try_import_torch.html">ray.rllib.utils.framework.try_import_torch</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.framework.try_import_tf.html">ray.rllib.utils.framework.try_import_tf</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.framework.try_import_tfp.html">ray.rllib.utils.framework.try_import_tfp</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tf_utils.explained_variance.html">ray.rllib.utils.tf_utils.explained_variance</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tf_utils.flatten_inputs_to_1d_tensor.html">ray.rllib.utils.tf_utils.flatten_inputs_to_1d_tensor</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tf_utils.get_gpu_devices.html">ray.rllib.utils.tf_utils.get_gpu_devices</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tf_utils.get_placeholder.html">ray.rllib.utils.tf_utils.get_placeholder</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tf_utils.huber_loss.html">ray.rllib.utils.tf_utils.huber_loss</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tf_utils.l2_loss.html">ray.rllib.utils.tf_utils.l2_loss</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tf_utils.make_tf_callable.html">ray.rllib.utils.tf_utils.make_tf_callable</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tf_utils.minimize_and_clip.html">ray.rllib.utils.tf_utils.minimize_and_clip</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tf_utils.one_hot.html">ray.rllib.utils.tf_utils.one_hot</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tf_utils.reduce_mean_ignore_inf.html">ray.rllib.utils.tf_utils.reduce_mean_ignore_inf</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tf_utils.scope_vars.html">ray.rllib.utils.tf_utils.scope_vars</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tf_utils.warn_if_infinite_kl_divergence.html">ray.rllib.utils.tf_utils.warn_if_infinite_kl_divergence</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tf_utils.zero_logps_from_actions.html">ray.rllib.utils.tf_utils.zero_logps_from_actions</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.apply_grad_clipping.html">ray.rllib.utils.torch_utils.apply_grad_clipping</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.concat_multi_gpu_td_errors.html">ray.rllib.utils.torch_utils.concat_multi_gpu_td_errors</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.convert_to_torch_tensor.html">ray.rllib.utils.torch_utils.convert_to_torch_tensor</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.explained_variance.html">ray.rllib.utils.torch_utils.explained_variance</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.flatten_inputs_to_1d_tensor.html">ray.rllib.utils.torch_utils.flatten_inputs_to_1d_tensor</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.global_norm.html">ray.rllib.utils.torch_utils.global_norm</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.huber_loss.html">ray.rllib.utils.torch_utils.huber_loss</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.l2_loss.html">ray.rllib.utils.torch_utils.l2_loss</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.minimize_and_clip.html">ray.rllib.utils.torch_utils.minimize_and_clip</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.one_hot.html">ray.rllib.utils.torch_utils.one_hot</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.reduce_mean_ignore_inf.html">ray.rllib.utils.torch_utils.reduce_mean_ignore_inf</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.sequence_mask.html">ray.rllib.utils.torch_utils.sequence_mask</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.warn_if_infinite_kl_divergence.html">ray.rllib.utils.torch_utils.warn_if_infinite_kl_divergence</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.set_torch_seed.html">ray.rllib.utils.torch_utils.set_torch_seed</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.torch_utils.softmax_cross_entropy_with_logits.html">ray.rllib.utils.torch_utils.softmax_cross_entropy_with_logits</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.numpy.aligned_array.html">ray.rllib.utils.numpy.aligned_array</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.numpy.concat_aligned.html">ray.rllib.utils.numpy.concat_aligned</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.numpy.convert_to_numpy.html">ray.rllib.utils.numpy.convert_to_numpy</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.numpy.fc.html">ray.rllib.utils.numpy.fc</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.numpy.flatten_inputs_to_1d_tensor.html">ray.rllib.utils.numpy.flatten_inputs_to_1d_tensor</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.numpy.make_action_immutable.html">ray.rllib.utils.numpy.make_action_immutable</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.numpy.huber_loss.html">ray.rllib.utils.numpy.huber_loss</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.numpy.l2_loss.html">ray.rllib.utils.numpy.l2_loss</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.numpy.lstm.html">ray.rllib.utils.numpy.lstm</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.numpy.one_hot.html">ray.rllib.utils.numpy.one_hot</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.numpy.relu.html">ray.rllib.utils.numpy.relu</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.numpy.sigmoid.html">ray.rllib.utils.numpy.sigmoid</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.numpy.softmax.html">ray.rllib.utils.numpy.softmax</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.checkpoints.Checkpointable.html">ray.rllib.utils.checkpoints.Checkpointable</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.checkpoints.convert_to_msgpack_checkpoint.html">ray.rllib.utils.checkpoints.convert_to_msgpack_checkpoint</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.checkpoints.convert_to_msgpack_policy_checkpoint.html">ray.rllib.utils.checkpoints.convert_to_msgpack_policy_checkpoint</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.checkpoints.get_checkpoint_info.html">ray.rllib.utils.checkpoints.get_checkpoint_info</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.checkpoints.try_import_msgpack.html">ray.rllib.utils.checkpoints.try_import_msgpack</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.policy.compute_log_likelihoods_from_input_dict.html">ray.rllib.utils.policy.compute_log_likelihoods_from_input_dict</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.policy.create_policy_for_framework.html">ray.rllib.utils.policy.create_policy_for_framework</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.policy.local_policy_inference.html">ray.rllib.utils.policy.local_policy_inference</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.policy.parse_policy_specs_from_checkpoint.html">ray.rllib.utils.policy.parse_policy_specs_from_checkpoint</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.utils.tensor_dtype.get_np_dtype.html">ray.rllib.utils.tensor_dtype.get_np_dtype</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.common.CLIArguments.html">ray.rllib.common.CLIArguments</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.common.FrameworkEnum.html">ray.rllib.common.FrameworkEnum</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.common.SupportedFileType.html">ray.rllib.common.SupportedFileType</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.core.rl_module.validate_module_id.html">ray.rllib.core.rl_module.validate_module_id</a></li> <li class="toctree-l4"><a class="reference internal" href="../rllib/package_ref/doc/ray.rllib.train.load_experiments_from_file.html">ray.rllib.train.load_experiments_from_file</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="../rllib/package_ref/external-app.html">External Application API</a></li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="../ray-more-libs/index.html">More Libraries</a><input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-43"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../ray-more-libs/joblib.html">Distributed Scikit-learn / Joblib</a></li> <li class="toctree-l2"><a class="reference internal" href="../ray-more-libs/multiprocessing.html">Distributed multiprocessing.Pool</a></li> <li class="toctree-l2"><a class="reference internal" href="../ray-more-libs/ray-collective.html">Ray Collective Communication Lib</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../ray-more-libs/dask-on-ray.html">Using Dask on Ray</a><input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-44"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3 has-children"><a class="reference internal" href="../ray-more-libs/doc/ray.util.dask.RayDaskCallback.html">ray.util.dask.RayDaskCallback</a><input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-45"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../ray-more-libs/doc/ray.util.dask.RayDaskCallback.ray_active.html">ray.util.dask.RayDaskCallback.ray_active</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="../ray-more-libs/doc/ray.util.dask.callbacks.RayDaskCallback._ray_presubmit.html">ray.util.dask.callbacks.RayDaskCallback._ray_presubmit</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-more-libs/doc/ray.util.dask.callbacks.RayDaskCallback._ray_postsubmit.html">ray.util.dask.callbacks.RayDaskCallback._ray_postsubmit</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-more-libs/doc/ray.util.dask.callbacks.RayDaskCallback._ray_pretask.html">ray.util.dask.callbacks.RayDaskCallback._ray_pretask</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-more-libs/doc/ray.util.dask.callbacks.RayDaskCallback._ray_posttask.html">ray.util.dask.callbacks.RayDaskCallback._ray_posttask</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-more-libs/doc/ray.util.dask.callbacks.RayDaskCallback._ray_postsubmit_all.html">ray.util.dask.callbacks.RayDaskCallback._ray_postsubmit_all</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-more-libs/doc/ray.util.dask.callbacks.RayDaskCallback._ray_finish.html">ray.util.dask.callbacks.RayDaskCallback._ray_finish</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../ray-more-libs/raydp.html">Using Spark on Ray (RayDP)</a></li> <li class="toctree-l2"><a class="reference internal" href="../ray-more-libs/mars-on-ray.html">Using Mars on Ray</a></li> <li class="toctree-l2"><a class="reference internal" href="../ray-more-libs/modin/index.html">Using Pandas on Ray (Modin)</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../workflows/index.html">Ray Workflows (Alpha)</a><input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-46"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../workflows/key-concepts.html">Key Concepts</a></li> <li class="toctree-l3"><a class="reference internal" href="../workflows/basics.html">Getting Started</a></li> <li class="toctree-l3"><a class="reference internal" href="../workflows/management.html">Workflow Management</a></li> <li class="toctree-l3"><a class="reference internal" href="../workflows/metadata.html">Workflow Metadata</a></li> <li class="toctree-l3"><a class="reference internal" href="../workflows/events.html">Events</a></li> <li class="toctree-l3"><a class="reference internal" href="../workflows/comparison.html">API Comparisons</a></li> <li class="toctree-l3"><a class="reference internal" href="../workflows/advanced.html">Advanced Topics</a></li> <li class="toctree-l3 has-children"><a class="reference internal" href="../workflows/api/api.html">Ray Workflows API</a><input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-47"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../workflows/api/execution.html">Workflow Execution API</a></li> <li class="toctree-l4"><a class="reference internal" href="../workflows/api/management.html">Workflow Management API</a></li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="../cluster/getting-started.html">Ray Clusters</a><input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-48"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../cluster/key-concepts.html">Key Concepts</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../cluster/kubernetes/index.html">Deploying on Kubernetes</a><input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-49"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3 has-children"><a class="reference internal" href="../cluster/kubernetes/getting-started.html">Getting Started with KubeRay</a><input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-50"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/getting-started/raycluster-quick-start.html">RayCluster Quickstart</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/getting-started/rayjob-quick-start.html">RayJob Quickstart</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/getting-started/rayservice-quick-start.html">RayService Quickstart</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../cluster/kubernetes/user-guides.html">User Guides</a><input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-51"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/rayservice.html">Deploy Ray Serve Apps</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/rayservice-high-availability.html">RayService high availability</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/observability.html">KubeRay Observability</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/upgrade-guide.html">KubeRay upgrade guide</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/k8s-cluster-setup.html">Managed Kubernetes services</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/storage.html">Best Practices for Storage and Dependencies</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/config.html">RayCluster Configuration</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/configuring-autoscaling.html">KubeRay Autoscaling</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/kuberay-gcs-ft.html">GCS fault tolerance in KubeRay</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/gke-gcs-bucket.html">Configuring KubeRay to use Google Cloud Storage Buckets in GKE</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/logging.html">Log Persistence</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/gpu.html">Using GPUs</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/tpu.html">Use TPUs with KubeRay</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/rayserve-dev-doc.html">Developing Ray Serve Python scripts on a RayCluster</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/pod-command.html">Specify container commands for Ray head/worker Pods</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/pod-security.html">Pod Security</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/helm-chart-rbac.html">Helm Chart RBAC</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/tls.html">TLS Authentication</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/k8s-autoscaler.html">(Advanced) Understanding the Ray Autoscaler in the Context of Kubernetes</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/user-guides/static-ray-cluster-without-kuberay.html">(Advanced) Deploying a static Ray cluster without KubeRay</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../cluster/kubernetes/examples.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-52"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/examples/ml-example.html">Ray Train XGBoostTrainer on Kubernetes</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/examples/gpu-training-example.html">Train PyTorch ResNet model with GPUs on Kubernetes</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/examples/mnist-training-example.html">Train a PyTorch model on Fashion MNIST with CPUs on Kubernetes</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/examples/stable-diffusion-rayservice.html">Serve a StableDiffusion text-to-image model on Kubernetes</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/examples/tpu-serve-stable-diffusion.html">Serve a Stable Diffusion model on GKE with TPUs</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/examples/mobilenet-rayservice.html">Serve a MobileNet image classifier on Kubernetes</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/examples/text-summarizer-rayservice.html">Serve a text summarizer on Kubernetes</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/examples/rayjob-batch-inference-example.html">RayJob Batch Inference Example</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/examples/rayjob-kueue-priority-scheduling.html">Priority Scheduling with RayJob and Kueue</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/examples/rayjob-kueue-gang-scheduling.html">Gang Scheduling with RayJob and Kueue</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/examples/distributed-checkpointing-with-gcsfuse.html">Distributed checkpointing with KubeRay and GCSFuse</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/examples/modin-example.html">Use Modin with Ray on Kubernetes</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/examples/vllm-rayservice.html">Serve a Large Language Model with vLLM on Kubernetes</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../cluster/kubernetes/k8s-ecosystem.html">KubeRay Ecosystem</a><input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-53"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/k8s-ecosystem/ingress.html">Ingress</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/k8s-ecosystem/prometheus-grafana.html">Using Prometheus and Grafana</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/k8s-ecosystem/pyspy.html">Profiling with py-spy</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/k8s-ecosystem/volcano.html">KubeRay integration with Volcano</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/k8s-ecosystem/yunikorn.html">KubeRay integration with Apache YuniKorn</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/k8s-ecosystem/kubeflow.html">Kubeflow: an interactive development solution</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/k8s-ecosystem/kueue.html">Gang scheduling and priority scheduling for RayJob with Kueue</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/k8s-ecosystem/istio.html">mTLS and L7 observability with Istio</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../cluster/kubernetes/benchmarks.html">KubeRay Benchmarks</a><input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-54"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/benchmarks/memory-scalability-benchmark.html">KubeRay memory and scalability benchmark</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../cluster/kubernetes/troubleshooting.html">KubeRay Troubleshooting</a><input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-55"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/troubleshooting/troubleshooting.html">Troubleshooting guide</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/kubernetes/troubleshooting/rayservice-troubleshooting.html">RayService troubleshooting</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="../cluster/kubernetes/references.html">API Reference</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../cluster/vms/index.html">Deploying on VMs</a><input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-56"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../cluster/vms/getting-started.html">Getting Started</a></li> <li class="toctree-l3 has-children"><a class="reference internal" href="../cluster/vms/user-guides/index.html">User Guides</a><input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-57"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../cluster/vms/user-guides/launching-clusters/index.html">Launching Ray Clusters on AWS, GCP, Azure, vSphere, On-Prem</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/vms/user-guides/large-cluster-best-practices.html">Best practices for deploying large clusters</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/vms/user-guides/configuring-autoscaling.html">Configuring Autoscaling</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/vms/user-guides/logging.html">Log Persistence</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/vms/user-guides/community/index.html">Community Supported Cluster Managers</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../cluster/vms/examples/index.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-58"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../cluster/vms/examples/ml-example.html">Ray Train XGBoostTrainer on VMs</a></li> </ul> </li> <li class="toctree-l3 has-children"><a class="reference internal" href="../cluster/vms/references/index.html">API References</a><input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-59"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../cluster/vms/references/ray-cluster-cli.html">Cluster Launcher Commands</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/vms/references/ray-cluster-configuration.html">Cluster YAML Configuration Options</a></li> </ul> </li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../cluster/metrics.html">Collecting and monitoring metrics</a></li> <li class="toctree-l2"><a class="reference internal" href="../cluster/configure-manage-dashboard.html">Configuring and Managing Ray Dashboard</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../cluster/running-applications/index.html">Applications Guide</a><input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-60"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3 has-children"><a class="reference internal" href="../cluster/running-applications/job-submission/index.html">Ray Jobs Overview</a><input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-61"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../cluster/running-applications/job-submission/quickstart.html">Quickstart using the Ray Jobs CLI</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/running-applications/job-submission/sdk.html">Python SDK Overview</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/running-applications/job-submission/jobs-package-ref.html">Python SDK API Reference</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/running-applications/job-submission/cli.html">Ray Jobs CLI API Reference</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/running-applications/job-submission/rest.html">Ray Jobs REST API</a></li> <li class="toctree-l4"><a class="reference internal" href="../cluster/running-applications/job-submission/ray-client.html">Ray Client</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="../cluster/running-applications/autoscaling/reference.html">Programmatic Cluster Scaling</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../cluster/faq.html">FAQ</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../cluster/package-overview.html">Ray Cluster Management API</a><input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-62"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../cluster/cli.html">Cluster Management CLI</a></li> <li class="toctree-l3"><a class="reference internal" href="../cluster/running-applications/job-submission/jobs-package-ref.html">Python SDK API Reference</a></li> <li class="toctree-l3"><a class="reference internal" href="../cluster/running-applications/job-submission/cli.html">Ray Jobs CLI API Reference</a></li> <li class="toctree-l3"><a class="reference internal" href="../cluster/running-applications/autoscaling/reference.html">Programmatic Cluster Scaling</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../cluster/usage-stats.html">Usage Stats Collection</a></li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="../ray-observability/index.html">Monitoring and Debugging</a><input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-63"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../ray-observability/getting-started.html">Ray Dashboard</a></li> <li class="toctree-l2"><a class="reference internal" href="../ray-observability/ray-distributed-debugger.html">Ray Distributed Debugger</a></li> <li class="toctree-l2"><a class="reference internal" href="../ray-observability/key-concepts.html">Key Concepts</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../ray-observability/user-guides/index.html">User Guides</a><input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-64"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3 has-children"><a class="reference internal" href="../ray-observability/user-guides/debug-apps/index.html">Debugging Applications</a><input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-65"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../ray-observability/user-guides/debug-apps/general-debugging.html">General Debugging</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-observability/user-guides/debug-apps/debug-memory.html">Debugging Memory Issues</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-observability/user-guides/debug-apps/debug-hangs.html">Debugging Hangs</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-observability/user-guides/debug-apps/debug-failures.html">Debugging Failures</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-observability/user-guides/debug-apps/optimize-performance.html">Optimizing Performance</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-observability/ray-distributed-debugger.html">Ray Distributed Debugger</a></li> <li class="toctree-l4"><a class="reference internal" href="../ray-observability/user-guides/debug-apps/ray-debugging.html">Using the Ray Debugger</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="../ray-observability/user-guides/cli-sdk.html">Monitoring with the CLI or SDK</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-observability/user-guides/configure-logging.html">Configuring Logging</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-observability/user-guides/profiling.html">Profiling</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-observability/user-guides/add-app-metrics.html">Adding Application-Level Metrics</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-observability/user-guides/ray-tracing.html">Tracing</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../ray-observability/reference/index.html">Reference</a><input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-66"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../ray-observability/reference/api.html">State API</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-observability/reference/cli.html">State CLI</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-observability/reference/system-metrics.html">System Metrics</a></li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="../ray-contribute/index.html">Developer Guides</a><input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-67"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../ray-contribute/stability.html">API Stability</a></li> <li class="toctree-l2"><a class="reference internal" href="../ray-contribute/api-policy.html">API Policy</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../ray-contribute/getting-involved.html">Getting Involved / Contributing</a><input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-68"><i class="fa-solid fa-chevron-down"></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../ray-contribute/development.html">Building Ray from Source</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-contribute/ci.html">CI Testing Workflow on PRs</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-contribute/docs.html">Contributing to the Ray Documentation</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-contribute/writing-code-snippets.html">How to write code snippets</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-contribute/fake-autoscaler.html">Testing Autoscaling Locally</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-contribute/testing-tips.html">Tips for testing Ray programs</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-contribute/debugging.html">Debugging for Ray Developers</a></li> <li class="toctree-l3"><a class="reference internal" href="../ray-contribute/profiling.html">Profiling for Ray Developers</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../ray-core/configure.html">Configuring Ray</a></li> <li class="toctree-l2"><a class="reference internal" href="../ray-contribute/whitepaper.html">Architecture Whitepapers</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../ray-references/glossary.html">Glossary</a></li> <li class="toctree-l1"><a class="reference internal" href="../ray-security/index.html">Security</a></li> </ul> </div> </nav></div> </div> <div class="sidebar-primary-items__end sidebar-primary__section"> </div> <div id="rtd-footer-container"></div> </div> <main id="main-content" class="bd-main"> <div class="bd-content"> <div class="bd-article-container"> <div class="bd-header-article"> <div class="header-article-items header-article__inner"> <div class="header-article-items__start"> <div class="header-article-item"> <nav aria-label="Breadcrumb"> <ul class="bd-breadcrumbs"> <li class="breadcrumb-item breadcrumb-home"> <a href="../index.html" class="nav-link" aria-label="Home"> <i class="fa-solid fa-home"></i> </a> </li> <li class="breadcrumb-item active" aria-current="page">Ray Train:...</li> </ul> </nav> </div> </div> </div> </div> <div id="searchbox"></div> <article class="bd-article" role="main"> <section id="ray-train-scalable-model-training"> <span id="train-docs"></span><h1>Ray Train: Scalable Model Training<a class="headerlink" href="#ray-train-scalable-model-training" title="Link to this heading">#</a></h1> <div class="toctree-wrapper compound"> </div> <div class="sd-d-flex-row sd-align-major-center sd-align-minor-center docutils"> <div class="sd-w-50 docutils"> <svg id="train-logo" viewBox="0 0 1060 297" xmlns="http://www.w3.org/2000/svg"> <g id="train-logo-icon"> <path stroke="black" d="M183 149H245" /> <path stroke="black" d="M172.771 58.5L247.5 129.712" /> <path stroke="black" d="M177 241.279L250.708 171" /> <path stroke="black" d="M130.5 136.619L62.8247 105" /> <path stroke="black" d="M130.5 161.598L61.5 194.402" /> <path stroke="black" d="M61.5 218.381L130.5 250.619" /> <path stroke="black" d="M62 80.9426L129.5 48.2992" /> <path stroke="black" d="M139.877 59L52.4795 181.5" /> <path stroke="black" d="M52.8362 117L140.947 240.5" /> <circle stroke="black" cx="156.5" cy="34.5" r="29.5" /> <circle stroke="black" cx="156.5" cy="262.5" r="29.5" /> <circle stroke="black" cx="34.5" cy="205.5" r="29.5" /> <circle stroke="black" cx="34.5" cy="91.5" r="29.5" /> <circle stroke="black" cx="156.5" cy="148.5" r="29.5" /> <circle stroke="black" cx="270.5" cy="148.5" r="29.5" /> </g> <path id="train-logo-text" d="M370.773 74.8125H416.965C426.796 74.8125 435.324 76.4076 442.551 79.5977C449.777 82.7878 455.344 87.5078 459.25 93.7578C463.221 99.9427 465.207 107.56 465.207 116.609C465.207 123.315 463.775 129.402 460.91 134.871C458.111 140.34 454.237 144.93 449.289 148.641C444.341 152.286 438.612 154.793 432.102 156.16L427.902 157.723H378.586L378.391 147.469H419.699C427.121 147.469 433.306 146.036 438.254 143.172C443.202 140.307 446.913 136.531 449.387 131.844C451.926 127.091 453.195 122.013 453.195 116.609C453.195 110.164 451.796 104.598 448.996 99.9102C446.262 95.1576 442.193 91.5117 436.789 88.9727C431.385 86.4336 424.777 85.1641 416.965 85.1641H382.785V217H370.773V74.8125ZM458.566 217L421.75 153.426L434.641 153.328L471.359 215.73V217H458.566ZM546.738 198.055V143.562C546.738 138.549 545.697 134.22 543.613 130.574C541.53 126.928 538.47 124.129 534.434 122.176C530.397 120.223 525.417 119.246 519.492 119.246C514.023 119.246 509.141 120.223 504.844 122.176C500.612 124.064 497.259 126.635 494.785 129.891C492.376 133.081 491.172 136.629 491.172 140.535L479.453 140.438C479.453 136.466 480.43 132.625 482.383 128.914C484.336 125.203 487.103 121.883 490.684 118.953C494.264 116.023 498.529 113.712 503.477 112.02C508.49 110.262 513.991 109.383 519.98 109.383C527.533 109.383 534.173 110.652 539.902 113.191C545.697 115.73 550.221 119.539 553.477 124.617C556.732 129.695 558.359 136.076 558.359 143.758V194.832C558.359 198.478 558.62 202.254 559.141 206.16C559.727 210.066 560.54 213.289 561.582 215.828V217H549.18C548.398 214.656 547.78 211.727 547.324 208.211C546.934 204.63 546.738 201.245 546.738 198.055ZM549.473 155.477L549.668 164.461H526.719C520.729 164.461 515.358 165.014 510.605 166.121C505.918 167.163 501.947 168.725 498.691 170.809C495.436 172.827 492.93 175.268 491.172 178.133C489.479 180.997 488.633 184.253 488.633 187.898C488.633 191.674 489.577 195.125 491.465 198.25C493.418 201.375 496.152 203.882 499.668 205.77C503.249 207.592 507.48 208.504 512.363 208.504C518.874 208.504 524.603 207.299 529.551 204.891C534.564 202.482 538.698 199.324 541.953 195.418C545.208 191.512 547.389 187.247 548.496 182.625L553.574 189.363C552.728 192.618 551.165 195.971 548.887 199.422C546.673 202.807 543.776 205.997 540.195 208.992C536.615 211.922 532.383 214.331 527.5 216.219C522.682 218.042 517.214 218.953 511.094 218.953C504.193 218.953 498.171 217.651 493.027 215.047C487.949 212.443 483.978 208.895 481.113 204.402C478.314 199.845 476.914 194.702 476.914 188.973C476.914 183.764 478.021 179.109 480.234 175.008C482.448 170.841 485.638 167.326 489.805 164.461C494.036 161.531 499.115 159.318 505.039 157.82C511.029 156.258 517.734 155.477 525.156 155.477H549.473ZM606.492 206.453L639.402 111.336H652L607.273 233.992C606.362 236.401 605.19 239.07 603.758 242C602.391 244.93 600.568 247.729 598.289 250.398C596.076 253.133 593.276 255.346 589.891 257.039C586.57 258.797 582.501 259.676 577.684 259.676C576.447 259.676 574.852 259.513 572.898 259.188C571.01 258.927 569.643 258.667 568.797 258.406L568.699 248.543C569.415 248.738 570.457 248.901 571.824 249.031C573.191 249.161 574.135 249.227 574.656 249.227C578.888 249.227 582.436 248.51 585.301 247.078C588.23 245.646 590.672 243.497 592.625 240.633C594.578 237.833 596.303 234.318 597.801 230.086L606.492 206.453ZM575.73 111.336L609.422 202.059L612.547 214.266L604.051 219.051L563.035 111.336H575.73ZM739.574 74.8125V217H727.66V74.8125H739.574ZM788.305 74.8125V85.1641H679.027V74.8125H788.305ZM799.914 128.816V217H788.293V111.336H799.621L799.914 128.816ZM837.316 110.555L837.023 121.297C835.721 121.102 834.452 120.939 833.215 120.809C831.978 120.678 830.643 120.613 829.211 120.613C824.133 120.613 819.673 121.557 815.832 123.445C812.056 125.268 808.866 127.84 806.262 131.16C803.658 134.415 801.672 138.257 800.305 142.684C798.938 147.046 798.156 151.733 797.961 156.746L793.664 158.406C793.664 151.505 794.38 145.092 795.812 139.168C797.245 133.243 799.426 128.068 802.355 123.641C805.35 119.148 809.094 115.665 813.586 113.191C818.143 110.652 823.482 109.383 829.602 109.383C831.099 109.383 832.564 109.513 833.996 109.773C835.493 109.969 836.6 110.229 837.316 110.555ZM903.027 198.055V143.562C903.027 138.549 901.986 134.22 899.902 130.574C897.819 126.928 894.759 124.129 890.723 122.176C886.686 120.223 881.706 119.246 875.781 119.246C870.312 119.246 865.43 120.223 861.133 122.176C856.901 124.064 853.548 126.635 851.074 129.891C848.665 133.081 847.461 136.629 847.461 140.535L835.742 140.438C835.742 136.466 836.719 132.625 838.672 128.914C840.625 125.203 843.392 121.883 846.973 118.953C850.553 116.023 854.818 113.712 859.766 112.02C864.779 110.262 870.28 109.383 876.27 109.383C883.822 109.383 890.462 110.652 896.191 113.191C901.986 115.73 906.51 119.539 909.766 124.617C913.021 129.695 914.648 136.076 914.648 143.758V194.832C914.648 198.478 914.909 202.254 915.43 206.16C916.016 210.066 916.829 213.289 917.871 215.828V217H905.469C904.688 214.656 904.069 211.727 903.613 208.211C903.223 204.63 903.027 201.245 903.027 198.055ZM905.762 155.477L905.957 164.461H883.008C877.018 164.461 871.647 165.014 866.895 166.121C862.207 167.163 858.236 168.725 854.98 170.809C851.725 172.827 849.219 175.268 847.461 178.133C845.768 180.997 844.922 184.253 844.922 187.898C844.922 191.674 845.866 195.125 847.754 198.25C849.707 201.375 852.441 203.882 855.957 205.77C859.538 207.592 863.77 208.504 868.652 208.504C875.163 208.504 880.892 207.299 885.84 204.891C890.853 202.482 894.987 199.324 898.242 195.418C901.497 191.512 903.678 187.247 904.785 182.625L909.863 189.363C909.017 192.618 907.454 195.971 905.176 199.422C902.962 202.807 900.065 205.997 896.484 208.992C892.904 211.922 888.672 214.331 883.789 216.219C878.971 218.042 873.503 218.953 867.383 218.953C860.482 218.953 854.46 217.651 849.316 215.047C844.238 212.443 840.267 208.895 837.402 204.402C834.603 199.845 833.203 194.702 833.203 188.973C833.203 183.764 834.31 179.109 836.523 175.008C838.737 170.841 841.927 167.326 846.094 164.461C850.326 161.531 855.404 159.318 861.328 157.82C867.318 156.258 874.023 155.477 881.445 155.477H905.762ZM945.984 111.336V217H934.363V111.336H945.984ZM932.312 80.7695C932.312 78.556 932.996 76.7005 934.363 75.2031C935.796 73.6406 937.749 72.8594 940.223 72.8594C942.697 72.8594 944.65 73.6406 946.082 75.2031C947.579 76.7005 948.328 78.556 948.328 80.7695C948.328 82.918 947.579 84.7734 946.082 86.3359C944.65 87.8333 942.697 88.582 940.223 88.582C937.749 88.582 935.796 87.8333 934.363 86.3359C932.996 84.7734 932.312 82.918 932.312 80.7695ZM976.539 133.895V217H964.918V111.336H976.051L976.539 133.895ZM973.902 157.625L968.727 154.695C969.117 148.445 970.387 142.586 972.535 137.117C974.684 131.648 977.581 126.831 981.227 122.664C984.938 118.497 989.267 115.242 994.215 112.898C999.228 110.555 1004.76 109.383 1010.82 109.383C1016.09 109.383 1020.81 110.099 1024.98 111.531C1029.14 112.964 1032.69 115.242 1035.62 118.367C1038.55 121.492 1040.76 125.496 1042.26 130.379C1043.82 135.262 1044.61 141.219 1044.61 148.25V217H1032.89V148.152C1032.89 140.861 1031.88 135.164 1029.86 131.062C1027.84 126.896 1024.98 123.934 1021.27 122.176C1017.55 120.418 1013.16 119.539 1008.08 119.539C1002.48 119.539 997.568 120.776 993.336 123.25C989.169 125.659 985.654 128.816 982.789 132.723C979.99 136.564 977.841 140.698 976.344 145.125C974.846 149.487 974.033 153.654 973.902 157.625Z" /> </svg> </div> </div> <p>Ray Train is a scalable machine learning library for distributed training and fine-tuning.</p> <p>Ray Train allows you to scale model training code from a single machine to a cluster of machines in the cloud, and abstracts away the complexities of distributed computing. Whether you have large models or large datasets, Ray Train is the simplest solution for distributed training.</p> <p>Ray Train provides support for many frameworks:</p> <table class="table"> <colgroup> <col style="width: 50.0%" /> <col style="width: 50.0%" /> </colgroup> <thead> <tr class="row-odd"><th class="head"><p>PyTorch Ecosystem</p></th> <th class="head"><p>More Frameworks</p></th> </tr> </thead> <tbody> <tr class="row-even"><td><p>PyTorch</p></td> <td><p>TensorFlow</p></td> </tr> <tr class="row-odd"><td><p>PyTorch Lightning</p></td> <td><p>Keras</p></td> </tr> <tr class="row-even"><td><p>Hugging Face Transformers</p></td> <td><p>Horovod</p></td> </tr> <tr class="row-odd"><td><p>Hugging Face Accelerate</p></td> <td><p>XGBoost</p></td> </tr> <tr class="row-even"><td><p>DeepSpeed</p></td> <td><p>LightGBM</p></td> </tr> </tbody> </table> <section id="install-ray-train"> <h2>Install Ray Train<a class="headerlink" href="#install-ray-train" title="Link to this heading">#</a></h2> <p>To install Ray Train, run:</p> <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>pip<span class="w"> </span>install<span class="w"> </span>-U<span class="w"> </span><span class="s2">"ray[train]"</span> </pre></div> </div> <p>To learn more about installing Ray and its libraries, see <a class="reference internal" href="../ray-overview/installation.html#installation"><span class="std std-ref">Installing Ray</span></a>.</p> </section> <section id="get-started"> <h2>Get started<a class="headerlink" href="#get-started" title="Link to this heading">#</a></h2> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 container pb-6 docutils"> <div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-1 sd-g-xs-1 sd-g-sm-1 sd-g-md-1 sd-g-lg-1 docutils"> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><strong>Overview</strong></p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">Understand the key concepts for distributed training with Ray Train.</p> </div> <div class="sd-card-footer docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-outline-primary reference internal" href="overview.html#train-overview"><span class="std std-ref">Learn the basics</span></a></span></p> </div> </div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><strong>PyTorch</strong></p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">Get started on distributed model training with Ray Train and PyTorch.</p> </div> <div class="sd-card-footer docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-outline-primary reference internal" href="getting-started-pytorch.html#train-pytorch"><span class="std std-ref">Try Ray Train with PyTorch</span></a></span></p> </div> </div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><strong>PyTorch Lightning</strong></p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">Get started on distributed model training with Ray Train and Lightning.</p> </div> <div class="sd-card-footer docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-outline-primary reference internal" href="getting-started-pytorch-lightning.html#train-pytorch-lightning"><span class="std std-ref">Try Ray Train with Lightning</span></a></span></p> </div> </div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><strong>Hugging Face Transformers</strong></p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">Get started on distributed model training with Ray Train and Transformers.</p> </div> <div class="sd-card-footer docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-outline-primary reference internal" href="getting-started-transformers.html#train-pytorch-transformers"><span class="std std-ref">Try Ray Train with Transformers</span></a></span></p> </div> </div> </div> </div> </div> </section> <section id="learn-more"> <h2>Learn more<a class="headerlink" href="#learn-more" title="Link to this heading">#</a></h2> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 container pb-6 docutils"> <div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-1 sd-g-xs-1 sd-g-sm-1 sd-g-md-1 sd-g-lg-1 docutils"> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><strong>More Frameworks</strong></p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">Don鈥檛 see your framework? See these guides.</p> </div> <div class="sd-card-footer docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-outline-primary reference internal" href="more-frameworks.html#train-more-frameworks"><span class="std std-ref">Try Ray Train with other frameworks</span></a></span></p> </div> </div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><strong>User Guides</strong></p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">Get how-to instructions for common training tasks with Ray Train.</p> </div> <div class="sd-card-footer docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-outline-primary reference internal" href="user-guides.html#train-user-guides"><span class="std std-ref">Read how-to guides</span></a></span></p> </div> </div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><strong>Examples</strong></p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">Browse end-to-end code examples for different use cases.</p> </div> <div class="sd-card-footer docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-outline-primary reference internal" href="examples.html"><span class="doc">Learn through examples</span></a></span></p> </div> </div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><strong>API</strong></p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">Consult the API Reference for full descriptions of the Ray Train API.</p> </div> <div class="sd-card-footer docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-outline-primary reference internal" href="api/api.html#train-api"><span class="std std-ref">Read the API Reference</span></a></span></p> </div> </div> </div> </div> </div> </section> </section> </article> <footer class="prev-next-footer">  <div class="prev-next-area"> <a class="left-prev" href="../data/data-internals.html" title="previous page"> <i class="fa-solid fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Ray Data Internals</p> </div> </a> <a class="right-next" href="overview.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Ray Train Overview</p> </div> <i class="fa-solid fa-angle-right"></i> </a> </div> </footer> </div> <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner"> <div class="sidebar-secondary-item"> <div class="page-toc tocsection onthispage"> <i class="fa-solid fa-list"></i> On this page </div> <nav class="bd-toc-nav page-toc"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#install-ray-train">Install Ray Train</a></li> <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#get-started">Get started</a></li> <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#learn-more">Learn more</a></li> </ul> </nav></div> <div class="sidebar-secondary-item"> <div class="tocsection editthispage"> <a href="https://github.com/ray-project/ray/edit/master/doc/source/train/train.rst"> <i class="fa-solid fa-pencil"></i> Edit on GitHub </a> </div> </div> </div></div> </div> <footer class="bd-footer-content"> <div class="footer-content-items footer-content__inner"> <div class="footer-content-item"><div id="csat"> <div id="csat-feedback-received" class="csat-hidden"> <span>Thanks for the feedback!</span> </div> <div id="csat-inputs"> <span>Was this helpful?</span> <div id="csat-yes" class="csat-button"> <svg id="csat-yes-icon" class="csat-hidden csat-icon" width="18" height="13" viewBox="0 0 18 13" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M7.00023 10.172L16.1922 0.979004L17.6072 2.393L7.00023 13L0.63623 6.636L2.05023 5.222L7.00023 10.172Z" /> </svg> <span>Yes<span> </div> <div id="csat-no" class="csat-button"> <svg id="csat-no-icon" class="csat-hidden csat-icon" width="14" height="14" viewBox="0 0 14 14" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M7.00023 5.58599L11.9502 0.635986L13.3642 2.04999L8.41423 6.99999L13.3642 11.95L11.9502 13.364L7.00023 8.41399L2.05023 13.364L0.63623 11.95L5.58623 6.99999L0.63623 2.04999L2.05023 0.635986L7.00023 5.58599Z" /> </svg> <span>No<span> </div> </div> <div id="csat-textarea-group" class="csat-hidden"> <span id="csat-feedback-label">Feedback</span> <textarea id="csat-textarea"></textarea> <div id="csat-submit">Submit</div> </div> </div></div> </div> </footer> </main> </div> </div>  <script src="../_static/scripts/bootstrap.js?digest=ac02cc09edc035673794"></script> <script src="../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794"></script> <footer class="bd-footer"> <div class="bd-footer__inner bd-page-width"> <div class="footer-items__start"> <div class="footer-item"> <p class="copyright"> 漏 Copyright 2024, The Ray Team. <br/> </p> </div> <div class="footer-item"> <p class="sphinx-version"> Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7. <br/> </p> </div> </div> <div class="footer-items__end"> <div class="footer-item"><p class="theme-version"> Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.14.1. </p></div> </div> </div> </footer> </body> </html>