Skip to content

Commit 338fbae

Browse files
mandar2812mandar2812
committed
Updating docs for release 1.4.1
1 parent 993bdc8 commit 338fbae

File tree

110 files changed

+17230
-302
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+17230
-302
lines changed

‎build.sbt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ packageDescription := "DynaML is a scala library/repl for implementing and worki
1212
"which can be extended easily to implement advanced models for small and large scale applications.\n\n"+
1313
"But the library can also be used as an educational/research tool for data analysis."
1414

15-
val mainVersion = "v1.4.1-beta.13"
15+
val mainVersion = "v1.4.1"
1616

1717
val dataDirectory = settingKey[File]("The directory holding the data files for running example scripts")
1818

‎docs/api_docs/v1.4.1/dynaml-core/buildinfo/BuildInfo$.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ <h4 class="signature">
428428
<img src="../lib/permalink.png" alt="Permalink" />
429429
</a>
430430
</span>
431-
<p class="shortcomment cmt">The value is &quot;v1.4.1-beta.13&quot;.</p>
431+
<p class="shortcomment cmt">The value is &quot;v1.4.1&quot;.</p>
432432
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
433433
<a id="wait():Unit"></a>
434434
<a id="wait():Unit"></a>

‎docs/api_docs/v1.4.1/dynaml-core/deprecated-list.html‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,14 @@
1111

1212
</head>
1313
<body><div class="entry">
14+
<div class="name">FeedForwardNetwork</div>
15+
<div class="occurrences"><a href="io/github/mandar2812/dynaml/models/neuralnets/package.html" class="extype" name="io.github.mandar2812.dynaml.models.neuralnets">neuralnets</a> </div>
16+
</div><div class="entry">
1417
<div class="name">featuresGaussianStandardization</div>
1518
<div class="occurrences"><a href="io/github/mandar2812/dynaml/DynaMLPipe$.html" class="extype" name="io.github.mandar2812.dynaml.DynaMLPipe">DynaMLPipe</a> </div>
19+
</div><div class="entry">
20+
<div class="name">NeuralNetwork</div>
21+
<div class="occurrences"><a href="io/github/mandar2812/dynaml/models/neuralnets/package.html" class="extype" name="io.github.mandar2812.dynaml.models.neuralnets">neuralnets</a> </div>
1622
</div><div class="entry">
1723
<div class="name">processTargets</div>
1824
<div class="occurrences"><a href="io/github/mandar2812/dynaml/models/gp/GPRegression.html" class="extype" name="io.github.mandar2812.dynaml.models.gp.GPRegression">GPRegression</a> </div>

‎docs/api_docs/v1.4.1/dynaml-core/index.html‎

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

‎docs/api_docs/v1.4.1/dynaml-core/index.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api_docs/v1.4.1/dynaml-core/io/github/mandar2812/dynaml/DynaMLPipe$.html‎

Lines changed: 13 additions & 13 deletions
Large diffs are not rendered by default.

‎docs/api_docs/v1.4.1/dynaml-core/io/github/mandar2812/dynaml/analysis/DifferentiableMap.html‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,23 @@ <h4 class="signature">
237237
</a>
238238
</span>
239239
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>DataPipe</dd></dl></div>
240+
</li><li name="io.github.mandar2812.dynaml.pipes.DataPipe#apply" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
241+
<a id="apply[T&lt;:Traversable[Source]](data:T):T"></a>
242+
<a id="apply[T&lt;:Traversable[S]](T):T"></a>
243+
<h4 class="signature">
244+
<span class="modifier_kind">
245+
<span class="modifier"></span>
246+
<span class="kind">def</span>
247+
</span>
248+
<span class="symbol">
249+
<span class="name">apply</span><span class="tparams">[<span name="T">T &lt;: <span class="extype" name="scala.Traversable">Traversable</span>[<span class="extype" name="io.github.mandar2812.dynaml.analysis.DifferentiableMap.S">S</span>]</span>]</span><span class="params">(<span name="data">data: <span class="extype" name="io.github.mandar2812.dynaml.pipes.DataPipe.apply.T">T</span></span>)</span><span class="result">: <span class="extype" name="io.github.mandar2812.dynaml.pipes.DataPipe.apply.T">T</span></span>
250+
</span>
251+
</h4><span class="permalink">
252+
<a href="../../../../../index.html#io.github.mandar2812.dynaml.analysis.DifferentiableMap@apply[T&lt;:Traversable[Source]](data:T):T" title="Permalink" target="_top">
253+
<img src="../../../../../lib/permalink.png" alt="Permalink" />
254+
</a>
255+
</span>
256+
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>DataPipe</dd></dl></div>
240257
</li><li name="io.github.mandar2812.dynaml.pipes.DataPipe#apply" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
241258
<a id="apply(data:Source):Destination"></a>
242259
<a id="apply(S):D"></a>

‎docs/api_docs/v1.4.1/dynaml-core/io/github/mandar2812/dynaml/analysis/PushforwardMap.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -309,23 +309,23 @@ <h4 class="signature">
309309
<p class="shortcomment cmt">Return the implementation used for calculating
310310
determinant of the inverse function's Jacobian
311311
</p>
312-
</li><li name="io.github.mandar2812.dynaml.pipes.Encoder#apply" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
313-
<a id="apply[T[S]&lt;:Traversable[S]](data:T[S]):T[D]"></a>
314-
<a id="apply[T[S]&lt;:Traversable[S]](T[Source]):T[Destination]"></a>
312+
</li><li name="io.github.mandar2812.dynaml.pipes.DataPipe#apply" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
313+
<a id="apply[T&lt;:Traversable[Source]](data:T):T"></a>
314+
<a id="apply[T&lt;:Traversable[Source]](T):T"></a>
315315
<h4 class="signature">
316316
<span class="modifier_kind">
317317
<span class="modifier"></span>
318318
<span class="kind">def</span>
319319
</span>
320320
<span class="symbol">
321-
<span class="name">apply</span><span class="tparams">[<span name="T">T<span class="tparams">[<span name="S">S</span>]</span> &lt;: <span class="extype" name="scala.Traversable">Traversable</span>[<span class="extype" name="io.github.mandar2812.dynaml.pipes.Encoder.apply.T.S">S</span>]</span>]</span><span class="params">(<span name="data">data: <span class="extype" name="io.github.mandar2812.dynaml.pipes.Encoder.apply.T">T</span>[<span class="extype" name="io.github.mandar2812.dynaml.analysis.PushforwardMap.Source">Source</span>]</span>)</span><span class="result">: <span class="extype" name="io.github.mandar2812.dynaml.pipes.Encoder.apply.T">T</span>[<span class="extype" name="io.github.mandar2812.dynaml.analysis.PushforwardMap.Destination">Destination</span>]</span>
321+
<span class="name">apply</span><span class="tparams">[<span name="T">T &lt;: <span class="extype" name="scala.Traversable">Traversable</span>[<span class="extype" name="io.github.mandar2812.dynaml.analysis.PushforwardMap.Source">Source</span>]</span>]</span><span class="params">(<span name="data">data: <span class="extype" name="io.github.mandar2812.dynaml.pipes.DataPipe.apply.T">T</span></span>)</span><span class="result">: <span class="extype" name="io.github.mandar2812.dynaml.pipes.DataPipe.apply.T">T</span></span>
322322
</span>
323323
</h4><span class="permalink">
324-
<a href="../../../../../index.html#io.github.mandar2812.dynaml.analysis.PushforwardMap@apply[T[S]&lt;:Traversable[S]](data:T[S]):T[D]" title="Permalink" target="_top">
324+
<a href="../../../../../index.html#io.github.mandar2812.dynaml.analysis.PushforwardMap@apply[T&lt;:Traversable[Source]](data:T):T" title="Permalink" target="_top">
325325
<img src="../../../../../lib/permalink.png" alt="Permalink" />
326326
</a>
327327
</span>
328-
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Encoder</dd></dl></div>
328+
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>DataPipe</dd></dl></div>
329329
</li><li name="io.github.mandar2812.dynaml.pipes.DataPipe#apply" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
330330
<a id="apply(data:Source):Destination"></a>
331331
<a id="apply(Source):Destination"></a>

‎docs/api_docs/v1.4.1/dynaml-core/io/github/mandar2812/dynaml/graph/FFNeuralGraph.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,15 @@ <h4 id="signature" class="signature">
4747
<span class="kind">class</span>
4848
</span>
4949
<span class="symbol">
50-
<span class="name">FFNeuralGraph</span><span class="result"> extends <a href="NeuralGraph.html" class="extype" name="io.github.mandar2812.dynaml.graph.NeuralGraph">NeuralGraph</a>[<span class="extype" name="com.tinkerpop.frames.FramedGraph">FramedGraph</span>[<span class="extype" name="com.tinkerpop.blueprints.Graph">Graph</span>]]</span>
50+
<span class="name">FFNeuralGraph</span><span class="result"> extends <a href="NeuralGraph.html" class="extype" name="io.github.mandar2812.dynaml.graph.NeuralGraph">NeuralGraph</a>[<span class="extype" name="com.tinkerpop.frames.FramedGraph">FramedGraph</span>[<span class="extype" name="com.tinkerpop.blueprints.Graph">Graph</span>], <span class="extype" name="breeze.linalg.DenseVector">DenseVector</span>[<span class="extype" name="scala.Double">Double</span>], <span class="extype" name="breeze.linalg.DenseVector">DenseVector</span>[<span class="extype" name="scala.Double">Double</span>]]</span>
5151
</span>
5252
</h4>
5353

5454
<div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Represents the underlying graph of a
5555
feed-forward neural network.
5656
</p></div><div class="toggleContainer block">
5757
<span class="toggle">Linear Supertypes</span>
58-
<div class="superTypes hiddenContent"><a href="NeuralGraph.html" class="extype" name="io.github.mandar2812.dynaml.graph.NeuralGraph">NeuralGraph</a>[<span class="extype" name="com.tinkerpop.frames.FramedGraph">FramedGraph</span>[<span class="extype" name="com.tinkerpop.blueprints.Graph">Graph</span>]], <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
58+
<div class="superTypes hiddenContent"><a href="NeuralGraph.html" class="extype" name="io.github.mandar2812.dynaml.graph.NeuralGraph">NeuralGraph</a>[<span class="extype" name="com.tinkerpop.frames.FramedGraph">FramedGraph</span>[<span class="extype" name="com.tinkerpop.blueprints.Graph">Graph</span>], <span class="extype" name="breeze.linalg.DenseVector">DenseVector</span>[<span class="extype" name="scala.Double">Double</span>], <span class="extype" name="breeze.linalg.DenseVector">DenseVector</span>[<span class="extype" name="scala.Double">Double</span>]], <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
5959
</div></div>
6060

6161

@@ -504,7 +504,7 @@ <h4 class="signature">
504504
</a>
505505
</span>
506506
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
507-
</li><li name="io.github.mandar2812.dynaml.graph.FFNeuralGraph#num_inputs" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
507+
</li><li name="io.github.mandar2812.dynaml.graph.FFNeuralGraph#num_inputs" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
508508
<a id="num_inputs:Int"></a>
509509
<a id="num_inputs:Int"></a>
510510
<h4 class="signature">
@@ -520,8 +520,8 @@ <h4 class="signature">
520520
<img src="../../../../../lib/permalink.png" alt="Permalink" />
521521
</a>
522522
</span>
523-
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="io.github.mandar2812.dynaml.graph.FFNeuralGraph">FFNeuralGraph</a> → <a href="NeuralGraph.html" class="extype" name="io.github.mandar2812.dynaml.graph.NeuralGraph">NeuralGraph</a></dd></dl></div>
524-
</li><li name="io.github.mandar2812.dynaml.graph.FFNeuralGraph#num_outputs" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
523+
524+
</li><li name="io.github.mandar2812.dynaml.graph.FFNeuralGraph#num_outputs" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
525525
<a id="num_outputs:Int"></a>
526526
<a id="num_outputs:Int"></a>
527527
<h4 class="signature">
@@ -537,7 +537,7 @@ <h4 class="signature">
537537
<img src="../../../../../lib/permalink.png" alt="Permalink" />
538538
</a>
539539
</span>
540-
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="io.github.mandar2812.dynaml.graph.FFNeuralGraph">FFNeuralGraph</a> → <a href="NeuralGraph.html" class="extype" name="io.github.mandar2812.dynaml.graph.NeuralGraph">NeuralGraph</a></dd></dl></div>
540+
541541
</li><li name="io.github.mandar2812.dynaml.graph.FFNeuralGraph#predictBatch" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
542542
<a id="predictBatch(procInputs:List[List[Double]]):scala.collection.immutable.Map[Int,scala.collection.immutable.Map[Int,Double]]"></a>
543543
<a id="predictBatch(List[List[Double]]):Map[Int,Map[Int,Double]]"></a>
@@ -678,7 +678,7 @@ <h4 class="signature">
678678

679679
<div id="inheritedMembers">
680680
<div class="parent" name="io.github.mandar2812.dynaml.graph.NeuralGraph">
681-
<h3>Inherited from <a href="NeuralGraph.html" class="extype" name="io.github.mandar2812.dynaml.graph.NeuralGraph">NeuralGraph</a>[<span class="extype" name="com.tinkerpop.frames.FramedGraph">FramedGraph</span>[<span class="extype" name="com.tinkerpop.blueprints.Graph">Graph</span>]]</h3>
681+
<h3>Inherited from <a href="NeuralGraph.html" class="extype" name="io.github.mandar2812.dynaml.graph.NeuralGraph">NeuralGraph</a>[<span class="extype" name="com.tinkerpop.frames.FramedGraph">FramedGraph</span>[<span class="extype" name="com.tinkerpop.blueprints.Graph">Graph</span>], <span class="extype" name="breeze.linalg.DenseVector">DenseVector</span>[<span class="extype" name="scala.Double">Double</span>], <span class="extype" name="breeze.linalg.DenseVector">DenseVector</span>[<span class="extype" name="scala.Double">Double</span>]]</h3>
682682
</div><div class="parent" name="scala.AnyRef">
683683
<h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3>
684684
</div><div class="parent" name="scala.Any">

0 commit comments

Comments
 (0)