-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 49ab84a
Showing
196 changed files
with
14,925 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
259 changes: 259 additions & 0 deletions
259
api/Bonsai.ML.LinearDynamicalSystems.CreateModelReference.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,259 @@ | ||
<!DOCTYPE html> | ||
<html> | ||
<head> | ||
<meta charset="utf-8"> | ||
<title>Class CreateModelReference | Bonsai.ML </title> | ||
<meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
<meta name="title" content="Class CreateModelReference | Bonsai.ML "> | ||
|
||
<meta name="description" content="Represents an operator that creates a reference for a named model."> | ||
<link rel="icon" href="../favicon.ico"> | ||
<link rel="stylesheet" href="../public/docfx.min.css"> | ||
<link rel="stylesheet" href="../public/main.css"> | ||
<meta name="docfx:navrel" content="../toc.html"> | ||
<meta name="docfx:tocrel" content="toc.html"> | ||
|
||
<meta name="docfx:rel" content="../"> | ||
|
||
|
||
<meta name="docfx:docurl" content="https://github.com/bonsai-rx/machinelearning/new/main/apidoc/new?filename=Bonsai_ML_LinearDynamicalSystems_CreateModelReference.md&value=---%0Auid%3A%20Bonsai.ML.LinearDynamicalSystems.CreateModelReference%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A"> | ||
<meta name="loc:inThisArticle" content="In this article"> | ||
<meta name="loc:searchResultsCount" content="{count} results for "{query}""> | ||
<meta name="loc:searchNoResults" content="No results for "{query}""> | ||
<meta name="loc:tocFilter" content="Filter by title"> | ||
<meta name="loc:nextArticle" content="Next"> | ||
<meta name="loc:prevArticle" content="Previous"> | ||
<meta name="loc:themeLight" content="Light"> | ||
<meta name="loc:themeDark" content="Dark"> | ||
<meta name="loc:themeAuto" content="Auto"> | ||
<meta name="loc:changeTheme" content="Change theme"> | ||
<meta name="loc:copy" content="Copy"> | ||
<meta name="loc:downloadPdf" content="Download PDF"> | ||
</head> | ||
|
||
<script type="module" src="./../public/docfx.min.js"></script> | ||
|
||
<script> | ||
const theme = localStorage.getItem('theme') || 'auto' | ||
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) | ||
</script> | ||
|
||
|
||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference"> | ||
<header class="bg-body border-bottom"> | ||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> | ||
<div class="container-xxl flex-nowrap"> | ||
<a class="navbar-brand" href="../index.html"> | ||
<img id="logo" class="svg" src="../logo.svg" alt="Bonsai - ML"> | ||
Bonsai - ML | ||
</a> | ||
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation"> | ||
<i class="bi bi-three-dots"></i> | ||
</button> | ||
<div class="collapse navbar-collapse" id="navpanel"> | ||
<div id="navbar"> | ||
<form class="search" role="search" id="search"> | ||
<i class="bi bi-search"></i> | ||
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search"> | ||
</form> | ||
</div> | ||
</div> | ||
</div> | ||
</nav> | ||
</header> | ||
|
||
<main class="container-xxl"> | ||
<div class="toc-offcanvas"> | ||
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> | ||
<div class="offcanvas-header"> | ||
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> | ||
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> | ||
</div> | ||
<div class="offcanvas-body"> | ||
<nav class="toc" id="toc"></nav> | ||
</div> | ||
</div> | ||
</div> | ||
|
||
<div class="content"> | ||
<div class="actionbar"> | ||
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> | ||
<i class="bi bi-list"></i> | ||
</button> | ||
|
||
<nav id="breadcrumb"></nav> | ||
</div> | ||
|
||
<article data-uid="Bonsai.ML.LinearDynamicalSystems.CreateModelReference"> | ||
|
||
|
||
|
||
<h1 id="Bonsai_ML_LinearDynamicalSystems_CreateModelReference" data-uid="Bonsai.ML.LinearDynamicalSystems.CreateModelReference" class="text-break"> | ||
Class CreateModelReference <a class="header-action link-secondary" title="View source" href="https://github.com/bonsai-rx/machinelearning/blob/docs-dev/src/Bonsai.ML.LinearDynamicalSystems/CreateModelReference.cs/#L10"><i class="bi bi-code-slash"></i></a> | ||
</h1> | ||
|
||
<div class="facts text-secondary"> | ||
<dl><dt>Namespace</dt><dd><a class="xref" href="Bonsai.html">Bonsai</a>.<a class="xref" href="Bonsai.ML.html">ML</a>.<a class="xref" href="Bonsai.ML.LinearDynamicalSystems.html">LinearDynamicalSystems</a></dd></dl> | ||
<dl><dt>Assembly</dt><dd>Bonsai.ML.LinearDynamicalSystems.dll</dd></dl> | ||
</div> | ||
|
||
<div class="markdown summary"><p>Represents an operator that creates a reference for a named model.</p> | ||
</div> | ||
<div class="markdown conceptual"></div> | ||
|
||
<div class="codewrapper"> | ||
<pre><code class="lang-csharp hljs">[Combinator] | ||
[WorkflowElementCategory(ElementCategory.Source)] | ||
public class CreateModelReference : INamedElement</code></pre> | ||
</div> | ||
|
||
|
||
|
||
|
||
<dl class="typelist inheritance"> | ||
<dt>Inheritance</dt> | ||
<dd> | ||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div> | ||
<div><span class="xref">CreateModelReference</span></div> | ||
</dd> | ||
</dl> | ||
|
||
<dl class="typelist implements"> | ||
<dt>Implements</dt> | ||
<dd> | ||
<div><a class="xref" href="https://bonsai-rx.org/docs/api/Bonsai.INamedElement.html">INamedElement</a></div> | ||
</dd> | ||
</dl> | ||
|
||
|
||
<dl class="typelist inheritedMembers"> | ||
<dt>Inherited Members</dt> | ||
<dd> | ||
<div> | ||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a> | ||
</div> | ||
<div> | ||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a> | ||
</div> | ||
<div> | ||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a> | ||
</div> | ||
<div> | ||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a> | ||
</div> | ||
<div> | ||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a> | ||
</div> | ||
<div> | ||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a> | ||
</div> | ||
<div> | ||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a> | ||
</div> | ||
</dd></dl> | ||
|
||
|
||
|
||
|
||
|
||
|
||
<h2 class="section" id="properties">Properties | ||
</h2> | ||
|
||
|
||
<a id="Bonsai_ML_LinearDynamicalSystems_CreateModelReference_Name_" data-uid="Bonsai.ML.LinearDynamicalSystems.CreateModelReference.Name*"></a> | ||
|
||
<h3 id="Bonsai_ML_LinearDynamicalSystems_CreateModelReference_Name" data-uid="Bonsai.ML.LinearDynamicalSystems.CreateModelReference.Name"> | ||
Name | ||
<a class="header-action link-secondary" title="View source" href="https://github.com/bonsai-rx/machinelearning/blob/docs-dev/src/Bonsai.ML.LinearDynamicalSystems/CreateModelReference.cs/#L18"><i class="bi bi-code-slash"></i></a> | ||
</h3> | ||
|
||
<div class="markdown level1 summary"><p>Gets or sets the name of the model to reference.</p> | ||
</div> | ||
<div class="markdown level1 conceptual"></div> | ||
|
||
<div class="codewrapper"> | ||
<pre><code class="lang-csharp hljs">public string Name { get; set; }</code></pre> | ||
</div> | ||
|
||
|
||
|
||
|
||
|
||
<h4 class="section">Property Value</h4> | ||
<dl class="parameters"> | ||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt> | ||
<dd></dd> | ||
</dl> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h2 class="section" id="methods">Methods | ||
</h2> | ||
|
||
|
||
<a id="Bonsai_ML_LinearDynamicalSystems_CreateModelReference_Process_" data-uid="Bonsai.ML.LinearDynamicalSystems.CreateModelReference.Process*"></a> | ||
|
||
<h3 id="Bonsai_ML_LinearDynamicalSystems_CreateModelReference_Process" data-uid="Bonsai.ML.LinearDynamicalSystems.CreateModelReference.Process"> | ||
Process() | ||
<a class="header-action link-secondary" title="View source" href="https://github.com/bonsai-rx/machinelearning/blob/docs-dev/src/Bonsai.ML.LinearDynamicalSystems/CreateModelReference.cs/#L28"><i class="bi bi-code-slash"></i></a> | ||
</h3> | ||
|
||
<div class="markdown level1 summary"><p>Generates an observable sequence that contains the model reference object.</p> | ||
</div> | ||
<div class="markdown level1 conceptual"></div> | ||
|
||
<div class="codewrapper"> | ||
<pre><code class="lang-csharp hljs">public IObservable<ModelReference> Process()</code></pre> | ||
</div> | ||
|
||
|
||
<h4 class="section">Returns</h4> | ||
<dl class="parameters"> | ||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a><<a class="xref" href="Bonsai.ML.LinearDynamicalSystems.ModelReference.html">ModelReference</a>></dt> | ||
<dd><p>A sequence containing a single instance of the <a class="xref" href="Bonsai.ML.LinearDynamicalSystems.ModelReference.html">ModelReference</a> | ||
class.</p> | ||
</dd> | ||
</dl> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</article> | ||
|
||
<div class="contribution d-print-none"> | ||
<a href="https://github.com/bonsai-rx/machinelearning/blob/docs-dev/src/Bonsai.ML.LinearDynamicalSystems/CreateModelReference.cs/#L10" class="edit-link">Edit this page</a> | ||
</div> | ||
|
||
|
||
</div> | ||
|
||
<div class="affix"> | ||
<nav id="affix"></nav> | ||
</div> | ||
</main> | ||
|
||
<div class="container-xxl search-results" id="search-results"></div> | ||
|
||
<footer class="border-top text-secondary"> | ||
<div class="container-xxl"> | ||
<div class="flex-fill"> | ||
© 2024 Bonsai Foundation CIC and Contributors. Made with <a href="https://dotnet.github.io/docfx">docfx</a> | ||
</div> | ||
</div> | ||
</footer> | ||
</body> | ||
</html> |
Oops, something went wrong.