Skip to content

Commit 77b543f

Browse files
karpatickarpatic
committed
BuildDocs
1 parent 1a20cd8 commit 77b543f

File tree

30 files changed

+886
-883
lines changed

30 files changed

+886
-883
lines changed

‎docs/404.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@
3333

3434
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
3535
<ul>
36-
<li class="toctree-l1"><a class="reference internal" href="/products/langdrive/gettingStarted/">Getting Started</a>
36+
<li class="toctree-l1"><a class="reference internal" href="/products/langdrive/about/">About LangDrive</a>
3737
</li>
3838
</ul>
3939
<ul>
40-
<li class="toctree-l1"><a class="reference internal" href="/products/langdrive/.">About LangDrive</a>
40+
<li class="toctree-l1"><a class="reference internal" href="/products/langdrive/.">Getting Started</a>
4141
</li>
4242
</ul>
4343
<ul>

‎docs/about/index.html‎

Lines changed: 224 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" >
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" /><link rel="canonical" href="https://addy-ai.com/products/langdrive/about/" />
7+
<link rel="shortcut icon" href="../img/favicon.ico" />
8+
<title>About LangDrive - Langdrive</title>
9+
<link rel="stylesheet" href="../css/theme.css" />
10+
<link rel="stylesheet" href="../css/theme_extra.css" />
11+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
12+
13+
<script>
14+
// Current page data
15+
var mkdocs_page_name = "About LangDrive";
16+
var mkdocs_page_input_path = "about.md";
17+
var mkdocs_page_url = "/products/langdrive/about/";
18+
</script>
19+
20+
<!--[if lt IE 9]>
21+
<script src="../js/html5shiv.min.js"></script>
22+
<![endif]-->
23+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
24+
<script>hljs.highlightAll();</script>
25+
</head>
26+
27+
<body class="wy-body-for-nav" role="document">
28+
29+
<div class="wy-grid-for-nav">
30+
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
31+
<div class="wy-side-scroll">
32+
<div class="wy-side-nav-search">
33+
<a href=".." class="icon icon-home"> Langdrive
34+
</a><div role="search">
35+
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
36+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
37+
</form>
38+
</div>
39+
</div>
40+
41+
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
42+
<ul class="current">
43+
<li class="toctree-l1 current"><a class="reference internal current" href="./">About LangDrive</a>
44+
<ul class="current">
45+
<li class="toctree-l2"><a class="reference internal" href="#data-connectors-overview">Data Connectors Overview</a>
46+
<ul>
47+
<li class="toctree-l3"><a class="reference internal" href="#google-drive">Google Drive</a>
48+
<ul>
49+
<li class="toctree-l4"><a class="reference internal" href="#firestore">Firestore</a>
50+
</li>
51+
<li class="toctree-l4"><a class="reference internal" href="#emailretriever">EmailRetriever</a>
52+
</li>
53+
</ul>
54+
</li>
55+
</ul>
56+
</li>
57+
<li class="toctree-l2"><a class="reference internal" href="#llm-overview">LLM Overview</a>
58+
<ul>
59+
<li class="toctree-l3"><a class="reference internal" href="#huggingface">HuggingFace</a>
60+
</li>
61+
<li class="toctree-l3"><a class="reference internal" href="#herokuhandler">HerokuHandler</a>
62+
</li>
63+
<li class="toctree-l3"><a class="reference internal" href="#chatbot">Chatbot</a>
64+
</li>
65+
<li class="toctree-l3"><a class="reference internal" href="#utils">Utils</a>
66+
</li>
67+
<li class="toctree-l3"><a class="reference internal" href="#training">Training</a>
68+
</li>
69+
</ul>
70+
</li>
71+
<li class="toctree-l2"><a class="reference internal" href="#contributing">Contributing</a>
72+
</li>
73+
</ul>
74+
</li>
75+
</ul>
76+
<ul>
77+
<li class="toctree-l1"><a class="reference internal" href="..">Getting Started</a>
78+
</li>
79+
</ul>
80+
<ul>
81+
<li class="toctree-l1"><a class="reference internal" href="../yaml/">Yaml</a>
82+
</li>
83+
</ul>
84+
<ul>
85+
<li class="toctree-l1"><a class="reference internal" href="../cli/">CLI</a>
86+
</li>
87+
</ul>
88+
<ul>
89+
<li class="toctree-l1"><a class="reference internal" href="../demo/">Demo</a>
90+
</li>
91+
</ul>
92+
<ul>
93+
<li class="toctree-l1"><a class="reference internal" href="../contributors/">Contributors</a>
94+
</li>
95+
</ul>
96+
<p class="caption"><span class="caption-text">Security</span></p>
97+
<ul>
98+
<li class="toctree-l1"><a class="reference internal" href="../security/authentication/">App Authentication</a>
99+
</li>
100+
<li class="toctree-l1"><a class="reference internal" href="../security/verification/">App Verification</a>
101+
</li>
102+
</ul>
103+
<p class="caption"><span class="caption-text">Data Connectors</span></p>
104+
<ul>
105+
<li class="toctree-l1"><a class="reference internal" href="../api/dataOverview/">Overview</a>
106+
</li>
107+
<li class="toctree-l1"><a class="reference internal" href="../api/gdrive/">DriveUtils</a>
108+
</li>
109+
<li class="toctree-l1"><a class="reference internal" href="../api/email/">Email</a>
110+
</li>
111+
<li class="toctree-l1"><a class="reference internal" href="../api/firestore/">Firestore</a>
112+
</li>
113+
</ul>
114+
<p class="caption"><span class="caption-text">LLM Services</span></p>
115+
<ul>
116+
<li class="toctree-l1"><a class="reference internal" href="../api/llmOverview/">Overview</a>
117+
</li>
118+
<li class="toctree-l1"><a class="reference internal" href="../api/huggingFace/">HuggingFace</a>
119+
</li>
120+
<li class="toctree-l1"><a class="reference internal" href="../api/train/">Train</a>
121+
</li>
122+
<li class="toctree-l1"><a class="reference internal" href="../api/heroku/">Heroku</a>
123+
</li>
124+
<li class="toctree-l1"><a class="reference internal" href="../api/chatbot/">Chatbot</a>
125+
</li>
126+
</ul>
127+
</div>
128+
</div>
129+
</nav>
130+
131+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
132+
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
133+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
134+
<a href="..">Langdrive</a>
135+
136+
</nav>
137+
<div class="wy-nav-content">
138+
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
139+
<ul class="wy-breadcrumbs">
140+
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
141+
<li class="breadcrumb-item active">About LangDrive</li>
142+
<li class="wy-breadcrumbs-aside">
143+
</li>
144+
</ul>
145+
<hr/>
146+
</div>
147+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
148+
<div class="section" itemprop="articleBody">
149+
150+
<h1 id="welcome-to-langdrives-documentation-portal">Welcome to Langdrive's Documentation Portal</h1>
151+
<p>Langdrive: Easily train and deploy your favorite models. </p>
152+
<p>There are many ways to train and develop LLMs with LangDrive - One way is to configure a <a href="../yaml/">YAML</a> doc and by issuing a <a href="../cli/">CLI</a> command. Another way would be importing it as a class modules within a project of your own, YAML doc optional. </p>
153+
<p>Whether you're a beginner or an experienced developer, our Data Connectors and LLM tools empower you to build, integrate, and deploy with confidence. Data Connectors help source data from third parties (email, firestore, gdrive) and prepare it for your models. When it comes to training, hosting, and deploying models (Locally, Huggingface, SageMaker, CloudRun), our LLM tools have you covered. All of this is readily available from CLI arguements, a YAML doc, or directly in-code. </p>
154+
<p>LangDrive, built specifically for Node.js, makes training and deploying AI models effortless. We provide a library that facilitates data connection and automates training and deployment, ensuring your projects are easy to manage and scale.</p>
155+
<p>Read our <a href="./gettingStarted.md">Getting Started</a> page to jump right in or browse our documentation using the nav below.</p>
156+
<h2 id="data-connectors-overview"><a href="../api/dataOverview/">Data Connectors Overview</a></h2>
157+
<p>Get to grips with classes that help you fetch and process data. This includes <code>Firestore</code> for database interactions, <code>Google Drive</code> for file management, and <code>EmailRetriever</code> for fetching emails. </p>
158+
<h3 id="google-drive"><a href="../api/gdrive/">Google Drive</a></h3>
159+
<p>This section provides a comprehensive look at its constructor, various methods, and how it leverages Google APIs for file operations and authentication. Explore how <code>DriveUtils</code> enhances your Google Drive experience with functionalities covering file listing, information retrieval, and file management.</p>
160+
<h4 id="firestore"><a href="../api/firestore/">Firestore</a></h4>
161+
<p>Designed for robust interaction with Firebase Firestore, learn about its constructor, key methods, and how it can enhance your database interactions.</p>
162+
<h4 id="emailretriever"><a href="../api/email/">EmailRetriever</a></h4>
163+
<p>Tailored for retrieving emails from different email clients using SMTP configurations, discover its constructor, key methods, and additional features.</p>
164+
<h2 id="llm-overview"><a href="../api/llmOverview/">LLM Overview</a></h2>
165+
<p>Training and deploying LLMs require resources most of us do not have. That is where our <code>HuggingFace</code>, <code>HerokuHandler</code>, and <code>utils</code> class come into play. These set of classes fascilitate the training and deployment of your LLM. </p>
166+
<h4 id="huggingface"><a href="../api/huggingFace/">HuggingFace</a></h4>
167+
<p>Explore the <code>HuggingFace</code> class, your gateway to interacting with the Hugging Face API. Learn about its constructor, key methods, and how it can simplify your AI-driven tasks.</p>
168+
<h4 id="herokuhandler"><a href="../api/heroku/">HerokuHandler</a></h4>
169+
<p>Understand the <code>HerokuHandler</code> class, which simplifies interactions with the Heroku API. This overview covers its constructor, key methods, and how it can enhance your Heroku experience.</p>
170+
<h4 id="chatbot"><a href="../api/chatbot/">Chatbot</a></h4>
171+
<p>Discover the <code>DriveChatbot</code>, a demonstration and testing tool for Async Promises in chatbot interactions. Google <a href="https://developers.google.com/identity/protocols/oauth2">OAuth2</a> keys are required to run your own instance. Read our tutorial on OAuth2 on our <a href="https://addy.beehiiv.com/">blog</a>.</p>
172+
<h4 id="utils"><a href="../api/utils/">Utils</a></h4>
173+
<p>Understand the essential Node.js script for deploying machine learning models, including its main functions, modules, and how it utilizes various libraries for file operations and environment management. Includes CLI utils.</p>
174+
<h4 id="training"><a href="../api/train/">Training</a></h4>
175+
<p>This section covers its constructor, key methods, and how it streamlines the training process of your models.</p>
176+
<h2 id="contributing">Contributing</h2>
177+
<p>Interested in contributing to LangDrive? Check out our <a href="https://pages.github.io/addy-ai/langdrive/contributors.md">contributing guide</a>.</p>
178+
<hr />
179+
<p>Navigate through our sections to find comprehensive guides and insights that suit your development needs!</p>
180+
181+
</div>
182+
</div><footer>
183+
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
184+
<a href=".." class="btn btn-neutral float-right" title="Getting Started">Next <span class="icon icon-circle-arrow-right"></span></a>
185+
</div>
186+
187+
<hr/>
188+
189+
<div role="contentinfo">
190+
<!-- Copyright etc -->
191+
</div>
192+
193+
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
194+
</footer>
195+
196+
</div>
197+
</div>
198+
199+
</section>
200+
201+
</div>
202+
203+
<div class="rst-versions" role="note" aria-label="Versions">
204+
<span class="rst-current-version" data-toggle="rst-current-version">
205+
206+
207+
208+
<span><a href=".." style="color: #fcfcfc">Next &raquo;</a></span>
209+
210+
</span>
211+
</div>
212+
<script src="../js/jquery-3.6.0.min.js"></script>
213+
<script>var base_url = "..";</script>
214+
<script src="../js/theme_extra.js"></script>
215+
<script src="../js/theme.js"></script>
216+
<script src="../search/main.js"></script>
217+
<script>
218+
jQuery(function () {
219+
SphinxRtdTheme.Navigation.enable(true);
220+
});
221+
</script>
222+
223+
</body>
224+
</html>

‎docs/api/chatbot/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@
4040

4141
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4242
<ul>
43-
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/">Getting Started</a>
43+
<li class="toctree-l1"><a class="reference internal" href="../../about/">About LangDrive</a>
4444
</li>
4545
</ul>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="../..">About LangDrive</a>
47+
<li class="toctree-l1"><a class="reference internal" href="../..">Getting Started</a>
4848
</li>
4949
</ul>
5050
<ul>

‎docs/api/dataOverview/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@
4040

4141
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4242
<ul>
43-
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/">Getting Started</a>
43+
<li class="toctree-l1"><a class="reference internal" href="../../about/">About LangDrive</a>
4444
</li>
4545
</ul>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="../..">About LangDrive</a>
47+
<li class="toctree-l1"><a class="reference internal" href="../..">Getting Started</a>
4848
</li>
4949
</ul>
5050
<ul>

‎docs/api/email/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@
4040

4141
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4242
<ul>
43-
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/">Getting Started</a>
43+
<li class="toctree-l1"><a class="reference internal" href="../../about/">About LangDrive</a>
4444
</li>
4545
</ul>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="../..">About LangDrive</a>
47+
<li class="toctree-l1"><a class="reference internal" href="../..">Getting Started</a>
4848
</li>
4949
</ul>
5050
<ul>

‎docs/api/firestore/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@
4040

4141
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4242
<ul>
43-
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/">Getting Started</a>
43+
<li class="toctree-l1"><a class="reference internal" href="../../about/">About LangDrive</a>
4444
</li>
4545
</ul>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="../..">About LangDrive</a>
47+
<li class="toctree-l1"><a class="reference internal" href="../..">Getting Started</a>
4848
</li>
4949
</ul>
5050
<ul>

‎docs/api/gdrive/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@
4040

4141
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4242
<ul>
43-
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/">Getting Started</a>
43+
<li class="toctree-l1"><a class="reference internal" href="../../about/">About LangDrive</a>
4444
</li>
4545
</ul>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="../..">About LangDrive</a>
47+
<li class="toctree-l1"><a class="reference internal" href="../..">Getting Started</a>
4848
</li>
4949
</ul>
5050
<ul>

‎docs/api/heroku/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@
4040

4141
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4242
<ul>
43-
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/">Getting Started</a>
43+
<li class="toctree-l1"><a class="reference internal" href="../../about/">About LangDrive</a>
4444
</li>
4545
</ul>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="../..">About LangDrive</a>
47+
<li class="toctree-l1"><a class="reference internal" href="../..">Getting Started</a>
4848
</li>
4949
</ul>
5050
<ul>

‎docs/api/huggingFace/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@
4040

4141
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4242
<ul>
43-
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/">Getting Started</a>
43+
<li class="toctree-l1"><a class="reference internal" href="../../about/">About LangDrive</a>
4444
</li>
4545
</ul>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="../..">About LangDrive</a>
47+
<li class="toctree-l1"><a class="reference internal" href="../..">Getting Started</a>
4848
</li>
4949
</ul>
5050
<ul>

‎docs/api/huggingFace_og/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@
4040

4141
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4242
<ul>
43-
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/">Getting Started</a>
43+
<li class="toctree-l1"><a class="reference internal" href="../../about/">About LangDrive</a>
4444
</li>
4545
</ul>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="../..">About LangDrive</a>
47+
<li class="toctree-l1"><a class="reference internal" href="../..">Getting Started</a>
4848
</li>
4949
</ul>
5050
<ul>

0 commit comments

Comments
 (0)