Deploying to gh-pages from @ 66dba85 🚀

EricLBuehler · Aug 18, 2024 · 72e82cb · 72e82cb
1 parent 0939aef
commit 72e82cb
Show file tree

Hide file tree

Showing 80 changed files with 1,002 additions and 769 deletions.
diff --git a/mistralrs/all.html b/mistralrs/all.html
diff --git a/mistralrs/constant.GGUF_MULTI_FILE_DELIMITER.html b/mistralrs/constant.GGUF_MULTI_FILE_DELIMITER.html
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `GGUF_MULTI_FILE_DELIMITER` constant in crate `mistralrs`."><title>GGUF_MULTI_FILE_DELIMITER in mistralrs - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="mistralrs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.1 (3f5fd8dd4 2024-08-06)" data-channel="1.80.1" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc constant"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../mistralrs/index.html">mistralrs</a><span class="version">0.2.5</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Constant <a href="index.html">mistralrs</a>::<wbr><a class="constant" href="#">GGUF_MULTI_FILE_DELIMITER</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/mistralrs_core/gguf/mod.rs.html#12">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub const GGUF_MULTI_FILE_DELIMITER: &amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.80.1/std/primitive.str.html">str</a>;</code></pre></section></div></main></body></html>
diff --git a/mistralrs/enum.GGUFArchitecture.html b/mistralrs/enum.GGUFArchitecture.html
diff --git a/mistralrs/enum.ModelSelected.html b/mistralrs/enum.ModelSelected.html
diff --git a/mistralrs/fn.get_toml_selected_model_dtype.html b/mistralrs/fn.get_toml_selected_model_dtype.html
@@ -1 +1 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `get_toml_selected_model_dtype` fn in crate `mistralrs`."><title>get_toml_selected_model_dtype in mistralrs - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="mistralrs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.1 (3f5fd8dd4 2024-08-06)" data-channel="1.80.1" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../mistralrs/index.html">mistralrs</a><span class="version">0.2.5</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="index.html">mistralrs</a>::<wbr><a class="fn" href="#">get_toml_selected_model_dtype</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/mistralrs_core/toml_selector.rs.html#288">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn get_toml_selected_model_dtype(model: &amp;TomlSelector) -&gt; <a class="enum" href="enum.ModelDType.html" title="enum mistralrs::ModelDType">ModelDType</a></code></pre></section></div></main></body></html>
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `get_toml_selected_model_dtype` fn in crate `mistralrs`."><title>get_toml_selected_model_dtype in mistralrs - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="mistralrs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.1 (3f5fd8dd4 2024-08-06)" data-channel="1.80.1" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../mistralrs/index.html">mistralrs</a><span class="version">0.2.5</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="index.html">mistralrs</a>::<wbr><a class="fn" href="#">get_toml_selected_model_dtype</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/mistralrs_core/toml_selector.rs.html#291">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn get_toml_selected_model_dtype(model: &amp;TomlSelector) -&gt; <a class="enum" href="enum.ModelDType.html" title="enum mistralrs::ModelDType">ModelDType</a></code></pre></section></div></main></body></html>
diff --git a/mistralrs/index.html b/mistralrs/index.html
@@ -53,7 +53,7 @@ <h3 id="example"><a class="doc-anchor" href="#example">§</a>Example</h3>
 step of the engine. For each scheduling step, the scheduler method is used if there
 are not only running, only waiting sequences, or none. If is it used, then it
 is used to allow waiting sequences to run.</div></li><li><div class="item-name"><a class="enum" href="enum.Device.html" title="enum mistralrs::Device">Device</a></div></li><li><div class="item-name"><a class="enum" href="enum.GGUFArchitecture.html" title="enum mistralrs::GGUFArchitecture">GGUFArchitecture</a></div></li><li><div class="item-name"><a class="enum" href="enum.IsqType.html" title="enum mistralrs::IsqType">IsqType</a></div></li><li><div class="item-name"><a class="enum" href="enum.MemoryGpuConfig.html" title="enum mistralrs::MemoryGpuConfig">MemoryGpuConfig</a></div></li><li><div class="item-name"><a class="enum" href="enum.MistralRsError.html" title="enum mistralrs::MistralRsError">MistralRsError</a></div></li><li><div class="item-name"><a class="enum" href="enum.ModelDType.html" title="enum mistralrs::ModelDType">ModelDType</a></div><div class="desc docblock-short">DType for the model.</div></li><li><div class="item-name"><a class="enum" href="enum.ModelKind.html" title="enum mistralrs::ModelKind">ModelKind</a></div><div class="desc docblock-short">The kind of model to build.</div></li><li><div class="item-name"><a class="enum" href="enum.ModelSelected.html" title="enum mistralrs::ModelSelected">ModelSelected</a></div></li><li><div class="item-name"><a class="enum" href="enum.NormalLoaderType.html" title="enum mistralrs::NormalLoaderType">NormalLoaderType</a></div><div class="desc docblock-short">The architecture to load the normal model as.</div></li><li><div class="item-name"><a class="enum" href="enum.Request.html" title="enum mistralrs::Request">Request</a></div><div class="desc docblock-short">A request to the Engine, encapsulating the various parameters as well as
-the <code>mspc</code> response <code>Sender</code> used to return the <a href="enum.Response.html" title="enum mistralrs::Response"><code>Response</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.RequestMessage.html" title="enum mistralrs::RequestMessage">RequestMessage</a></div><div class="desc docblock-short">Message or messages for a <a href="enum.Request.html" title="enum mistralrs::Request"><code>Request</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.Response.html" title="enum mistralrs::Response">Response</a></div><div class="desc docblock-short">The response enum contains 3 types of variants:</div></li><li><div class="item-name"><a class="enum" href="enum.SchedulerConfig.html" title="enum mistralrs::SchedulerConfig">SchedulerConfig</a></div></li><li><div class="item-name"><a class="enum" href="enum.StopTokens.html" title="enum mistralrs::StopTokens">StopTokens</a></div><div class="desc docblock-short">Stop sequences or ids.</div></li><li><div class="item-name"><a class="enum" href="enum.TokenSource.html" title="enum mistralrs::TokenSource">TokenSource</a></div><div class="desc docblock-short">The source of the HF token.</div></li><li><div class="item-name"><a class="enum" href="enum.ToolCallType.html" title="enum mistralrs::ToolCallType">ToolCallType</a></div></li><li><div class="item-name"><a class="enum" href="enum.ToolChoice.html" title="enum mistralrs::ToolChoice">ToolChoice</a></div></li><li><div class="item-name"><a class="enum" href="enum.ToolType.html" title="enum mistralrs::ToolType">ToolType</a></div></li><li><div class="item-name"><a class="enum" href="enum.VisionLoaderType.html" title="enum mistralrs::VisionLoaderType">VisionLoaderType</a></div><div class="desc docblock-short">The architecture to load the vision model as.</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.SYSTEM_FINGERPRINT.html" title="constant mistralrs::SYSTEM_FINGERPRINT">SYSTEM_FINGERPRINT</a></div></li></ul><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="static" href="static.TERMINATE_ALL_NEXT_STEP.html" title="static mistralrs::TERMINATE_ALL_NEXT_STEP">TERMINATE_ALL_NEXT_STEP</a></div><div class="desc docblock-short">Terminate all sequences on the next scheduling step. Be sure to reset this.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Loader.html" title="trait mistralrs::Loader">Loader</a></div><div class="desc docblock-short">The <code>Loader</code> trait abstracts the loading process. The primary entrypoint is the
+the <code>mspc</code> response <code>Sender</code> used to return the <a href="enum.Response.html" title="enum mistralrs::Response"><code>Response</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.RequestMessage.html" title="enum mistralrs::RequestMessage">RequestMessage</a></div><div class="desc docblock-short">Message or messages for a <a href="enum.Request.html" title="enum mistralrs::Request"><code>Request</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.Response.html" title="enum mistralrs::Response">Response</a></div><div class="desc docblock-short">The response enum contains 3 types of variants:</div></li><li><div class="item-name"><a class="enum" href="enum.SchedulerConfig.html" title="enum mistralrs::SchedulerConfig">SchedulerConfig</a></div></li><li><div class="item-name"><a class="enum" href="enum.StopTokens.html" title="enum mistralrs::StopTokens">StopTokens</a></div><div class="desc docblock-short">Stop sequences or ids.</div></li><li><div class="item-name"><a class="enum" href="enum.TokenSource.html" title="enum mistralrs::TokenSource">TokenSource</a></div><div class="desc docblock-short">The source of the HF token.</div></li><li><div class="item-name"><a class="enum" href="enum.ToolCallType.html" title="enum mistralrs::ToolCallType">ToolCallType</a></div></li><li><div class="item-name"><a class="enum" href="enum.ToolChoice.html" title="enum mistralrs::ToolChoice">ToolChoice</a></div></li><li><div class="item-name"><a class="enum" href="enum.ToolType.html" title="enum mistralrs::ToolType">ToolType</a></div></li><li><div class="item-name"><a class="enum" href="enum.VisionLoaderType.html" title="enum mistralrs::VisionLoaderType">VisionLoaderType</a></div><div class="desc docblock-short">The architecture to load the vision model as.</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.GGUF_MULTI_FILE_DELIMITER.html" title="constant mistralrs::GGUF_MULTI_FILE_DELIMITER">GGUF_MULTI_FILE_DELIMITER</a></div></li><li><div class="item-name"><a class="constant" href="constant.SYSTEM_FINGERPRINT.html" title="constant mistralrs::SYSTEM_FINGERPRINT">SYSTEM_FINGERPRINT</a></div></li></ul><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="static" href="static.TERMINATE_ALL_NEXT_STEP.html" title="static mistralrs::TERMINATE_ALL_NEXT_STEP">TERMINATE_ALL_NEXT_STEP</a></div><div class="desc docblock-short">Terminate all sequences on the next scheduling step. Be sure to reset this.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Loader.html" title="trait mistralrs::Loader">Loader</a></div><div class="desc docblock-short">The <code>Loader</code> trait abstracts the loading process. The primary entrypoint is the
 <code>load_model</code> method.</div></li><li><div class="item-name"><a class="trait" href="trait.ModelPaths.html" title="trait mistralrs::ModelPaths">ModelPaths</a></div><div class="desc docblock-short"><code>ModelPaths</code> abstracts the mechanism to get all necessary files for running a model. For
 example <code>LocalModelPaths</code> implements <code>ModelPaths</code> when all files are in the local file system.</div></li><li><div class="item-name"><a class="trait" href="trait.Pipeline.html" title="trait mistralrs::Pipeline">Pipeline</a></div></li><li><div class="item-name"><a class="trait" href="trait.TryIntoDType.html" title="trait mistralrs::TryIntoDType">TryIntoDType</a></div><div class="desc docblock-short">Type which can be converted to a DType</div></li><li><div class="item-name"><a class="trait" href="trait.VisionModelLoader.html" title="trait mistralrs::VisionModelLoader">VisionModelLoader</a></div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.get_model_dtype.html" title="fn mistralrs::get_model_dtype">get_model_dtype</a></div></li><li><div class="item-name"><a class="fn" href="fn.get_tgt_non_granular_index.html" title="fn mistralrs::get_tgt_non_granular_index">get_tgt_non_granular_index</a></div></li><li><div class="item-name"><a class="fn" href="fn.get_toml_selected_model_dtype.html" title="fn mistralrs::get_toml_selected_model_dtype">get_toml_selected_model_dtype</a></div></li><li><div class="item-name"><a class="fn" href="fn.initialize_logging.html" title="fn mistralrs::initialize_logging">initialize_logging</a></div><div class="desc docblock-short">This should be called to initialize the debug flag and logging.
 This should not be called in mistralrs-core code due to Rust usage.</div></li><li><div class="item-name"><a class="fn" href="fn.paged_attn_supported.html" title="fn mistralrs::paged_attn_supported">paged_attn_supported</a></div></li><li><div class="item-name"><a class="fn" href="fn.parse_isq_value.html" title="fn mistralrs::parse_isq_value">parse_isq_value</a></div><div class="desc docblock-short">Parse ISQ value: one of</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.MessageContent.html" title="type mistralrs::MessageContent">MessageContent</a></div></li><li><div class="item-name"><a class="type" href="type.Result.html" title="type mistralrs::Result">Result</a></div></li></ul></section></div></main></body></html>