tsdoc.index.html.template
1 <!DOCTYPE html> 2 <html> 3 <head> 4 <title>MLflow TypeScript SDK Documentation</title> 5 <meta charset="utf-8"> 6 <meta name="viewport" content="width=device-width, initial-scale=1"> 7 8 <!-- Google tag (gtag.js) --> 9 <script async src="https://www.googletagmanager.com/gtag/js?id=AW-16857946923"></script> 10 <script> 11 window.dataLayer = window.dataLayer || []; 12 function gtag(){dataLayer.push(arguments);} 13 gtag('js', new Date()); 14 15 gtag('config', 'AW-16857946923'); 16 </script> 17 <!-- End gtag --> 18 <style> 19 body { 20 font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif; 21 line-height: 1.6; 22 color: #333; 23 max-width: 1200px; 24 margin: 0 auto; 25 padding: 2rem; 26 background-color: #f8f9fa; 27 } 28 .content { 29 background-color: white; 30 padding: 2rem; 31 border-radius: 8px; 32 box-shadow: 0 1px 3px rgba(0,0,0,0.1); 33 } 34 .header { 35 text-align: center; 36 margin-bottom: 3rem; 37 padding-bottom: 2rem; 38 border-bottom: 2px solid #e1e4e8; 39 } 40 .header h1 { 41 font-size: 2.5rem; 42 color: #2c3e50; 43 margin: 1rem 0; 44 font-weight: 600; 45 } 46 .header .logo { 47 margin-bottom: 1rem; 48 } 49 .header .logo img { 50 width: 200px; 51 height: auto; 52 } 53 .description { 54 font-size: 1.1rem; 55 color: #586069; 56 text-align: center; 57 margin: 2rem 0; 58 } 59 .description a { 60 color: #0366d6; 61 text-decoration: none; 62 } 63 .description a:hover { 64 text-decoration: underline; 65 } 66 .quickstart-section { 67 margin-top: 3rem; 68 } 69 .quickstart-section h2 { 70 font-size: 1.8rem; 71 color: #2c3e50; 72 margin-bottom: 1rem; 73 } 74 .quickstart-link { 75 display: inline-block; 76 margin-top: 1rem; 77 padding: 0.5rem 1rem; 78 background-color: #28a745; 79 color: white; 80 border-radius: 4px; 81 font-weight: 500; 82 text-decoration: none; 83 } 84 .quickstart-link:hover { 85 background-color: #218838; 86 text-decoration: none; 87 } 88 .api-docs-section { 89 margin-top: 3rem; 90 } 91 .api-docs-section h2 { 92 font-size: 1.8rem; 93 color: #2c3e50; 94 margin-bottom: 1rem; 95 } 96 .package-list { 97 display: grid; 98 grid-template-columns: repeat(auto-fit, minmax(300px, 1fr)); 99 gap: 1.5rem; 100 margin-top: 2rem; 101 } 102 .package-item { 103 background-color: #f6f8fa; 104 padding: 1.5rem; 105 border-radius: 8px; 106 border: 1px solid #e1e4e8; 107 transition: transform 0.2s, box-shadow 0.2s; 108 } 109 .package-item:hover { 110 transform: translateY(-2px); 111 box-shadow: 0 4px 8px rgba(0,0,0,0.1); 112 } 113 .package-item h3 { 114 margin-top: 0; 115 color: #2c3e50; 116 font-size: 1.3rem; 117 } 118 .package-item p { 119 margin: 0.5rem 0; 120 color: #586069; 121 } 122 .package-link { 123 display: inline-block; 124 margin-top: 1rem; 125 padding: 0.5rem 1rem; 126 background-color: #0366d6; 127 color: white; 128 border-radius: 4px; 129 font-weight: 500; 130 text-decoration: none; 131 } 132 .package-link:hover { 133 background-color: #0256c7; 134 text-decoration: none; 135 } 136 </style> 137 </head> 138 <body> 139 <div class="content"> 140 <div class="header"> 141 <div class="logo"> 142 <img src="https://raw.githubusercontent.com/mlflow/mlflow/refs/heads/master/assets/logo.svg" alt="MLflow Logo" /> 143 </div> 144 <h1>MLflow TypeScript SDK</h1> 145 <div class="description"> 146 This is the API reference for the MLflow TypeScript SDK, a set of packages for integrating your Node.js applications with <a href="https://mlflow.org">MLflow</a>. 147 </div> 148 </div> 149 150 <div class="quickstart-section"> 151 <h2>🚀 New to MLflow?</h2> 152 <p>Get started with our comprehensive quickstart guide that walks you through setting up MLflow tracing for your TypeScript applications.</p> 153 <a href="https://mlflow.org/docs/latest/genai/tracing/quickstart/typescript-openai" class="quickstart-link">View Quickstart Guide →</a> 154 </div> 155 156 <div class="api-docs-section"> 157 <h2>📚 API Reference</h2> 158 <p>Explore the detailed API documentation for each package:</p> 159 <div class="package-list"> 160 <div class="package-item"> 161 <h3>@mlflow/core</h3> 162 <p>Core tracing functionality and manual instrumentation for MLflow TypeScript SDK.</p> 163 <a href="mlflow-core/index.html" class="package-link">View API Docs →</a> 164 </div> 165 <div class="package-item"> 166 <h3>@mlflow/openai</h3> 167 <p>Auto-instrumentation integration for OpenAI, making it easy to trace OpenAI API calls.</p> 168 <a href="mlflow-openai/index.html" class="package-link">View API Docs →</a> 169 </div> 170 </div> 171 </div> 172 </div> 173 </body> 174 </html>