Skip to content

Commit

Permalink
Redirect HTML docs to the repo
Browse files Browse the repository at this point in the history 
Signed-off-by: Mike McKiernan <[email protected]>
  • Loading branch information
@mikemckiernan
mikemckiernan committed Jun 26, 2024
1 parent ca32f4e commit 534beb6
Show file tree
Hide file tree
Showing 81 changed files with 85 additions and 27,647 deletions.
10 changes: 5 additions & 5 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
<head>
<title>Redirect to documentation</title>
<meta charset="utf-8">
<meta http=equiv="refresh" content="3; URL=https://nvidia.github.io/GenerativeAIExamples//latest/index.html">
<link rel="canonical" href="https://nvidia.github.io/GenerativeAIExamples//latest/index.html">
<meta http=equiv="refresh" content="3; URL=https://github.com/nvidia/GenerativeAIExamples?tab=readme-ov-file#nvidia-generative-ai-examples">
<link rel="canonical" href="https://github.com/nvidia/GenerativeAIExamples?tab=readme-ov-file#nvidia-generative-ai-examples">
<script language="javascript">
function redirect() {
window.location.assign("https://nvidia.github.io/GenerativeAIExamples//latest/index.html")
window.location.assign("https://github.com/nvidia/GenerativeAIExamples?tab=readme-ov-file#nvidia-generative-ai-examples")
}
</script>
</head>
<body onload="redirect()">
<p>Please follow the link to the <a href="https://nvidia.github.io/GenerativeAIExamples//latest/index.html">
latest</a> documentation.</p>
<p>Please follow the link to the <a href="https://github.com/nvidia/GenerativeAIExamples?tab=readme-ov-file#nvidia-generative-ai-examples">
latest</a> documentation in the GitHub repository.</p>
</body>
</html>
21 changes: 1 addition & 20 deletions latest/_static/chain-server-api.html
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1 @@
<!DOCTYPE html>
<html>
<head>
<title>Chain Server API Reference</title>
<link href="https://unpkg.com/swagger-ui-dist@5/swagger-ui.css" rel="stylesheet" type="text/css"/>
<meta charset="utf-8"/>
</head>
<body>
<div id="swagger-ui-container"></div>
<script src=""></script>
<script src="https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js"></script>
<script>
config = {'url': '_static/openapi_schema.json'}
config["dom_id"] = "#swagger-ui-container"
window.onload = function() {
window.ui = SwaggerUIBundle(config);
}
</script>
</body>
</html>
<meta http-equiv="Refresh" content="0; url='https://github.com/nvidia/GenerativeAIExamples" />
425 changes: 1 addition & 424 deletions latest/api-catalog.html
View file

Large diffs are not rendered by default.

282 changes: 1 addition & 281 deletions latest/architecture.html
View file

Large diffs are not rendered by default.

435 changes: 1 addition & 434 deletions latest/boilerplate-api-catalog.html
View file

Large diffs are not rendered by default.

224 changes: 1 addition & 223 deletions latest/chain-server.html
View file
Original file line number Diff line number Diff line change
@@ -1,223 +1 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Chain Server &mdash; NVIDIA Generative AI Examples 24.6.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" type="text/css" />
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="_static/omni-style.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script src="_static/version.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Software Component Configuration" href="configuration.html" />
<link rel="prev" title="Jupyter Notebook Server" href="jupyter-server.html" />



</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >


<a href="index.html">
<img src="_static/nvidia-logo-white.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">RAG Pipelines for Developers</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">About the RAG Pipelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="support-matrix.html">Support Matrix</a></li>
<li class="toctree-l1"><a class="reference internal" href="api-catalog.html">API Catalog Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="query-decomposition.html">Query Decomposition</a></li>
<li class="toctree-l1"><a class="reference internal" href="structured-data.html">Structured Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="multimodal-data.html">Multimodal Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="multi-turn.html">Multi-turn</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-sample-web-application.html">Sample Chat Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="vector-database.html">Alternative Vector Database</a></li>
<li class="toctree-l1"><a class="reference internal" href="nim-llms.html">NIM for LLMs</a></li>
<li class="toctree-l1"><a class="reference internal" href="simple-examples.html">Developing Simple Examples</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Tools</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tools/evaluation/index.html">Evaluation</a></li>
<li class="toctree-l1"><a class="reference internal" href="observability.html">Observability</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Jupyter Notebooks</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="notebooks/01_dataloader.html">Press Release Chat Bot</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/02_Option%281%29_NVIDIA_AI_endpoint_simple.html">NVIDIA API Catalog with LangChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/02_Option%282%29_minimalistic_RAG_with_langchain_local_HF_LLM.html">LangChain with Local Llama 2 Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/03_Option%281%29_llama_index_with_NVIDIA_AI_endpoint.html">NVIDIA API Catalog, LlamaIndex, and LangChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/03_Option%282%29_llama_index_with_HF_local_LLM.html">HF Checkpoints with LlamaIndex and LangChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/04_Agent_use_tools_leveraging_NVIDIA_AI_endpoints.html">Multimodal Models from NVIDIA AI Catelog and AI Catalog with LangChain Agent</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/05_RAG_for_HTML_docs_with_Langchain_NVIDIA_AI_Endpoints.html">Build a RAG chain by generating embeddings for NVIDIA Triton documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/06_LangGraph_HandlingAgent_IntermediateSteps.html">LangGraph Handling LangChain Agent Intermediate_Steps</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/07_Chat_with_nvidia_financial_reports.html">Notebook: Chatting with NVIDIA Financial Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/08_RAG_Langchain_with_Local_NIM.html">Build a RAG using a locally hosted NIM</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Software Components</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="frontend.html">RAG Playground Web Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="jupyter-server.html">Jupyter Notebook Server</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Chain Server</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Software Component Configuration</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">NVIDIA Generative AI Examples</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Chain Server</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<!--
SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<section class="tex2jax_ignore mathjax_ignore" id="chain-server">
<h1>Chain Server<a class="headerlink" href="#chain-server" title="Permalink to this headline"></a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#about-the-chain-server" id="id1">About the Chain Server</a></p></li>
<li><p><a class="reference internal" href="#running-the-chain-server-independently" id="id2">Running the Chain Server Independently</a></p></li>
<li><p><a class="reference internal" href="#chain-server-rest-api-reference" id="id3">Chain Server REST API Reference</a></p></li>
</ul>
</div>
<section id="about-the-chain-server">
<h2>About the Chain Server<a class="headerlink" href="#about-the-chain-server" title="Permalink to this headline"></a></h2>
<p>The chain server is implemented as a sample FastAPI-based server so that you can experience a Q&amp;A chat bot.
The server wraps calls made to different components and orchestrates the entire flow for all the generative AI examples.</p>
</section>
<section id="running-the-chain-server-independently">
<h2>Running the Chain Server Independently<a class="headerlink" href="#running-the-chain-server-independently" title="Permalink to this headline"></a></h2>
<p>To run the server for development purposes, run the following commands:</p>
<ul>
<li><p>Build the container from source:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">source</span><span class="w"> </span>deploy/compose/compose.env
<span class="gp">$ </span>docker<span class="w"> </span>compose<span class="w"> </span>-f<span class="w"> </span>deploy/compose/rag-app-text-chatbot.yaml<span class="w"> </span>build<span class="w"> </span>chain-server
</pre></div>
</div>
</li>
<li><p>Start the container, which starts the server:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">source</span><span class="w"> </span>deploy/compose/compose.env
<span class="gp">$ </span>docker<span class="w"> </span>compose<span class="w"> </span>-f<span class="w"> </span>deploy/compose/rag-app-text-chatbot.yaml<span class="w"> </span>up<span class="w"> </span>chain-server
</pre></div>
</div>
</li>
<li><p>Open the swagger URL at <code class="docutils literal notranslate"><span class="pre">http://host-ip:8081</span></code> to try out the exposed endpoints.</p></li>
</ul>
</section>
<section id="chain-server-rest-api-reference">
<h2>Chain Server REST API Reference<a class="headerlink" href="#chain-server-rest-api-reference" title="Permalink to this headline"></a></h2>
<p>You can view the server REST API schema from the chain server by accessing <a class="reference external" href="http://host-ip:8081/docs">http://host-ip:8081/docs</a>.</p>
<p>Alternatively, you can view the same documentation in the following section.</p>
<!DOCTYPE html>
<html>
<head>
<title>Chain Server API Reference</title>
<link href="https://unpkg.com/swagger-ui-dist@5/swagger-ui.css" rel="stylesheet" type="text/css"/>
<meta charset="utf-8"/>
</head>
<body>
<div id="swagger-ui-container"></div>
<script src=""></script>
<script src="https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js"></script>
<script>
config = {'url': '_static/openapi_schema.json'}
config["dom_id"] = "#swagger-ui-container"
window.onload = function() {
window.ui = SwaggerUIBundle(config);
}
</script>
</body>
</html></section>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="jupyter-server.html" class="btn btn-neutral float-left" title="Jupyter Notebook Server" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="configuration.html" class="btn btn-neutral float-right" title="Software Component Configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2023-2024, NVIDIA Corporation.</p>
</div>



</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>




</body>
</html>
<meta http-equiv="Refresh" content="0; url='https://github.com/nvidia/GenerativeAIExamples" />
Loading

0 comments on commit 534beb6

Please sign in to comment.