|
| 1 | +<!DOCTYPE html> |
| 2 | +<html lang="en" data-bs-theme="light"> |
| 3 | + <head> |
| 4 | + <meta charset="utf-8"> |
| 5 | + <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| 6 | + <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | + <link rel="shortcut icon" href="../../img/favicon.ico"> |
| 11 | + <title>ScalarLM - ScalarLM Docs</title> |
| 12 | + <link href="../../css/bootstrap.min.css" rel="stylesheet"> |
| 13 | + <link href="../../css/fontawesome.min.css" rel="stylesheet"> |
| 14 | + <link href="../../css/brands.min.css" rel="stylesheet"> |
| 15 | + <link href="../../css/solid.min.css" rel="stylesheet"> |
| 16 | + <link href="../../css/v4-font-face.min.css" rel="stylesheet"> |
| 17 | + <link href="../../css/base.css" rel="stylesheet"> |
| 18 | + <link id="hljs-light" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" > |
| 19 | + <link id="hljs-dark" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css" disabled> |
| 20 | + <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script> |
| 21 | + <script>hljs.highlightAll();</script> |
| 22 | + </head> |
| 23 | + |
| 24 | + <body> |
| 25 | + <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary"> |
| 26 | + <div class="container"> |
| 27 | + <a class="navbar-brand" href="../..">ScalarLM Docs</a> |
| 28 | + <!-- Expander button --> |
| 29 | + <button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar-collapse" aria-controls="navbar-collapse" aria-expanded="false" aria-label="Toggle navigation"> |
| 30 | + <span class="navbar-toggler-icon"></span> |
| 31 | + </button> |
| 32 | + |
| 33 | + <!-- Expanded navigation --> |
| 34 | + <div id="navbar-collapse" class="navbar-collapse collapse"> |
| 35 | + <!-- Main navigation --> |
| 36 | + <ul class="nav navbar-nav"> |
| 37 | + <li class="nav-item dropdown"> |
| 38 | + <a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Getting Started</a> |
| 39 | + <ul class="dropdown-menu"> |
| 40 | + |
| 41 | +<li> |
| 42 | + <a href="../../index.md" class="dropdown-item">Introduction</a> |
| 43 | +</li> |
| 44 | + |
| 45 | +<li> |
| 46 | + <a href="../../quickstart.md" class="dropdown-item">Quick Start</a> |
| 47 | +</li> |
| 48 | + |
| 49 | +<li> |
| 50 | + <a href="../../arch.md" class="dropdown-item">Architecture</a> |
| 51 | +</li> |
| 52 | + |
| 53 | +<li> |
| 54 | + <a href="../../contact.md" class="dropdown-item">Contact</a> |
| 55 | +</li> |
| 56 | + </ul> |
| 57 | + </li> |
| 58 | + <li class="nav-item dropdown"> |
| 59 | + <a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Examples</a> |
| 60 | + <ul class="dropdown-menu"> |
| 61 | + |
| 62 | +<li> |
| 63 | + <a href="../../inference.md" class="dropdown-item">Inference</a> |
| 64 | +</li> |
| 65 | + |
| 66 | +<li> |
| 67 | + <a href="../../training.md" class="dropdown-item">Training</a> |
| 68 | +</li> |
| 69 | + </ul> |
| 70 | + </li> |
| 71 | + <li class="nav-item dropdown"> |
| 72 | + <a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Command Line</a> |
| 73 | + <ul class="dropdown-menu"> |
| 74 | + |
| 75 | +<li> |
| 76 | + <a href="../../cli/cli.md" class="dropdown-item">CLI</a> |
| 77 | +</li> |
| 78 | + |
| 79 | +<li> |
| 80 | + <a href="../../cli/list-models.md" class="dropdown-item">List Models</a> |
| 81 | +</li> |
| 82 | + |
| 83 | +<li> |
| 84 | + <a href="../../cli/training-logs.md" class="dropdown-item">Training Logs</a> |
| 85 | +</li> |
| 86 | + |
| 87 | +<li> |
| 88 | + <a href="../../cli/squeue.md" class="dropdown-item">Squeue</a> |
| 89 | +</li> |
| 90 | + |
| 91 | +<li> |
| 92 | + <a href="../../cli/plot.md" class="dropdown-item">Plot</a> |
| 93 | +</li> |
| 94 | + </ul> |
| 95 | + </li> |
| 96 | + <li class="nav-item dropdown"> |
| 97 | + <a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Deployment</a> |
| 98 | + <ul class="dropdown-menu"> |
| 99 | + |
| 100 | +<li> |
| 101 | + <a href="../../deployment/laptop.md" class="dropdown-item">Laptop</a> |
| 102 | +</li> |
| 103 | + |
| 104 | +<li> |
| 105 | + <a href="../../deployment/kubernetes.md" class="dropdown-item">Kubernetes</a> |
| 106 | +</li> |
| 107 | + |
| 108 | +<li> |
| 109 | + <a href="../../deployment/modal.md" class="dropdown-item">Modal</a> |
| 110 | +</li> |
| 111 | + |
| 112 | +<li> |
| 113 | + <a href="../../deployment/modal-details.md" class="dropdown-item">Modal Details</a> |
| 114 | +</li> |
| 115 | + |
| 116 | +<li> |
| 117 | + <a href="../../deployment/docker.md" class="dropdown-item">Docker</a> |
| 118 | +</li> |
| 119 | + </ul> |
| 120 | + </li> |
| 121 | + </ul> |
| 122 | + |
| 123 | + <ul class="nav navbar-nav ms-md-auto"> |
| 124 | + <li class="nav-item"> |
| 125 | + <a href="#" class="nav-link" data-bs-toggle="modal" data-bs-target="#mkdocs_search_modal"> |
| 126 | + <i class="fa fa-search"></i> Search |
| 127 | + </a> |
| 128 | + </li> |
| 129 | + </ul> |
| 130 | + </div> |
| 131 | + </div> |
| 132 | + </div> |
| 133 | + |
| 134 | + <div class="container"> |
| 135 | + <div class="row"> |
| 136 | + <div class="col-md-3"><div class="navbar-expand-md bs-sidebar hidden-print affix" role="complementary"> |
| 137 | + <div class="navbar-header"> |
| 138 | + <button type="button" class="navbar-toggler collapsed" data-bs-toggle="collapse" data-bs-target="#toc-collapse" title="Table of Contents"> |
| 139 | + <span class="fa fa-angle-down"></span> |
| 140 | + </button> |
| 141 | + </div> |
| 142 | + |
| 143 | + |
| 144 | + <div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary"> |
| 145 | + <ul class="nav flex-column"> |
| 146 | + |
| 147 | + <li class="nav-item" data-bs-level="1"><a href="#scalarlm" class="nav-link">ScalarLM</a> |
| 148 | + <ul class="nav flex-column"> |
| 149 | + </ul> |
| 150 | + </li> |
| 151 | + </ul> |
| 152 | + </div> |
| 153 | +</div></div> |
| 154 | + <div class="col-md-9" role="main"> |
| 155 | + |
| 156 | +<h1 id="scalarlm">ScalarLM</h1> |
| 157 | +<p>ScalarLM has three high level APIs:</p> |
| 158 | +<ul> |
| 159 | +<li><strong>completions</strong> provides OpenAI client compatibility</li> |
| 160 | +<li><strong>generate</strong> provides a simple interface for generating text</li> |
| 161 | +<li><strong>train</strong> provides a simple interface for submitting training jobs</li> |
| 162 | +</ul> |
| 163 | +<p><img alt="ScalarLM overview" src="../assets/cray-arch.png" /></p> |
| 164 | +<p>Inference is performed by vLLM workers that are orchestrated by pulling requests from a queue.</p> |
| 165 | +<p>Training is performed by Megatron-LM workers that are orchestrated by SLURM.</p> |
| 166 | +<p>Trained models are automatically registered with the inference workers.</p></div> |
| 167 | + </div> |
| 168 | + </div> |
| 169 | + |
| 170 | + <footer class="col-md-12"> |
| 171 | + <hr> |
| 172 | + <p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p> |
| 173 | + </footer> |
| 174 | + <script src="../../js/bootstrap.bundle.min.js"></script> |
| 175 | + <script> |
| 176 | + var base_url = "../..", |
| 177 | + shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83}; |
| 178 | + </script> |
| 179 | + <script src="../../js/base.js"></script> |
| 180 | + <script src="../../search/main.js"></script> |
| 181 | + |
| 182 | + <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true"> |
| 183 | + <div class="modal-dialog modal-lg"> |
| 184 | + <div class="modal-content"> |
| 185 | + <div class="modal-header"> |
| 186 | + <h4 class="modal-title" id="searchModalLabel">Search</h4> |
| 187 | + <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button> |
| 188 | + </div> |
| 189 | + <div class="modal-body"> |
| 190 | + <p>From here you can search these documents. Enter your search terms below.</p> |
| 191 | + <form> |
| 192 | + <div class="form-group"> |
| 193 | + <input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here"> |
| 194 | + </div> |
| 195 | + </form> |
| 196 | + <div id="mkdocs-search-results" data-no-results-text="No results found"></div> |
| 197 | + </div> |
| 198 | + <div class="modal-footer"> |
| 199 | + </div> |
| 200 | + </div> |
| 201 | + </div> |
| 202 | +</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true"> |
| 203 | + <div class="modal-dialog"> |
| 204 | + <div class="modal-content"> |
| 205 | + <div class="modal-header"> |
| 206 | + <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4> |
| 207 | + <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button> |
| 208 | + </div> |
| 209 | + <div class="modal-body"> |
| 210 | + <table class="table"> |
| 211 | + <thead> |
| 212 | + <tr> |
| 213 | + <th style="width: 20%;">Keys</th> |
| 214 | + <th>Action</th> |
| 215 | + </tr> |
| 216 | + </thead> |
| 217 | + <tbody> |
| 218 | + <tr> |
| 219 | + <td class="help shortcut"><kbd>?</kbd></td> |
| 220 | + <td>Open this help</td> |
| 221 | + </tr> |
| 222 | + <tr> |
| 223 | + <td class="next shortcut"><kbd>n</kbd></td> |
| 224 | + <td>Next page</td> |
| 225 | + </tr> |
| 226 | + <tr> |
| 227 | + <td class="prev shortcut"><kbd>p</kbd></td> |
| 228 | + <td>Previous page</td> |
| 229 | + </tr> |
| 230 | + <tr> |
| 231 | + <td class="search shortcut"><kbd>s</kbd></td> |
| 232 | + <td>Search</td> |
| 233 | + </tr> |
| 234 | + </tbody> |
| 235 | + </table> |
| 236 | + </div> |
| 237 | + <div class="modal-footer"> |
| 238 | + </div> |
| 239 | + </div> |
| 240 | + </div> |
| 241 | +</div> |
| 242 | + |
| 243 | + </body> |
| 244 | +</html> |
0 commit comments