diffsharp.github.io/README.html at master · DiffSharp/diffsharp.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<!DOCTYPE html>
<htmllang="en">
<head>
<metacharset="utf-8">
<title>Running notebooks in MyBinder
</title>
<metaname="viewport" content="width=device-width, initial-scale=1.0">

<metaname="author" content="Atılım Güneş Baydin, Don Syme, Barak A. Pearlmutter, Jeffrey Siskind, and DiffSharp contributors">
<metaname="description" content="DiffSharp is a tensor library with support for differentiable programming. It is designed for use in machine learning, probabilistic programming, optimization and other domains.">

<scriptsrc="https://code.jquery.com/jquery-1.8.0.js"></script>
<scriptsrc="https://code.jquery.com/ui/1.8.23/jquery-ui.js"></script>
<scriptsrc="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/js/bootstrap.min.js"></script>
<scripttype="text/javascript" asyncsrc="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<linkhref="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/css/bootstrap-combined.min.css" rel="stylesheet">

<linktype="text/css" rel="stylesheet" href="https://diffsharp.github.io/content/fsdocs-default.css" />
<scriptsrc="https://diffsharp.github.io/content/fsdocs-tips.js" type="text/javascript"></script>

<!-- BEGIN SEARCH BOX: this adds support for the search box -->
<linkrel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.css" />
<!-- END SEARCH BOX: this adds support for the search box -->
</head>
<body>
<divclass="container">
<!-- <div class="masthead">
 <ul class="nav nav-pills pull-right">
 <li><a href="https://fsharp.org">fsharp.org</a></li>
 </ul>
 <h3 class="muted">DiffSharp</h3>
 </div> -->
<!-- <hr /> -->
<divclass="row">
<divclass="col-xs-12" style="height:10px;"></div>
</div>
<divclass="row">
<divclass="span3" id="fsdocs-nav">
<ahref="index.html"><imgclass="logo" src="https://diffsharp.github.io/img/diffsharp-logo-text.png"/></a>

<!-- BEGIN SEARCH BOX: this adds support for the search box -->
<divid="header">
<divclass="searchbox">
<labelfor="search-by">
<iclass="fas fa-search"></i>
</label>
<inputdata-search-input="" id="search-by" type="search" placeholder="Search..." />
<spandata-search-clear="">
<iclass="fas fa-times"></i>
</span>
</div>
</div>
<!-- END SEARCH BOX: this adds support for the search box -->

<ulclass="nav nav-list" id="menu">
<!-- <li class="nav-header">DiffSharp</li> -->
<!-- <li class="divider"></li> -->
<li><ahref="https://diffsharp.github.io/index.html">Home</a></li>
<li><ahref="https://github.com/DiffSharp/DiffSharp/">GitHub</a></li>
<li><ahref="https://github.com/DiffSharp/DiffSharp/blob/dev/LICENSE">License (BSD)</a></li>

<liclass="nav-header">Getting Started</li>
<!-- <li class="divider"></li> -->
<li><ahref="https://diffsharp.github.io/install.html">Install</a></li>
<li><ahref="https://diffsharp.github.io/quickstart.html">Quickstart</a></li>
<!-- <li><a href="https://diffsharp.github.io/tensors.html">Tensors</a></li> -->
<!-- <li><a href="https://diffsharp.github.io/differentiable-programming.html">Differentiable Programming</a></li> -->
<!-- <li><a href="https://diffsharp.github.io/nested-derivatives.html">Nested Derivatives</a></li> -->
<!-- <li><a href="https://diffsharp.github.io/models.html">Models</a></li> -->
<!-- <li><a href="https://diffsharp.github.io/optimization.html">Optimization</a></li> -->
<!-- <li><a href="https://diffsharp.github.io/probability-distributions.html">Probability Distributions</a></li> -->

<liclass="nav-header">Tutorials</li>
<!-- <li class="divider"></li> -->
<!-- <li><a href="https://diffsharp.github.io/tutorial-classifier.html">Classifier</a></li> -->
<!-- <li><a href="https://diffsharp.github.io/tutorial-gan.html">GAN</a></li> -->
<!-- <li><a href="https://diffsharp.github.io/tutorial-vae.html">VAE</a></li> -->
<!-- <li><a href="https://diffsharp.github.io/tutorial-language.html">Language Models</a></li> -->
<li><ahref="https://github.com/DiffSharp/DiffSharp/tree/dev/examples">More Examples</a></li>

<liclass="nav-header">API Documentation</li>
<li><ahref="https://diffsharp.github.io/reference/index.html">API Reference</a></li>
<li><ahref="https://diffsharp.github.io/extensions.html">Extensions</a></li>

<!-- <li class="nav-header">Examples</li> -->
<!-- <li class="divider"></li> -->
<!-- <li class="nav-header">Machine Learning</li> -->
<!-- <li><a href="https://diffsharp.github.io/examples-topic1.html">Topic 1</a></li> -->

<!-- <li class="divider"></li>
 <li class="nav-header">Authors</li>
 <li><a href="http://www.robots.ox.ac.uk/~gunes/">Atılım Güneş Baydin</a></li>
 <li><a href="http://www.bcl.hamilton.ie/~barak/">Barak A. Pearlmutter</a></li>
 <li><a href="https://www.microsoft.com/en-us/research/people/dsyme/">Don Syme</a></li> -->
</ul>
</div>
<divclass="span9" id="fsdocs-content">
<h1><aname="Running-notebooks-in-MyBinder" class="anchor" href="#Running-notebooks-in-MyBinder">Running notebooks in MyBinder</a></h1>
<p>The <code>Dockerfile</code> and <code>NuGet.config</code> allow us to run generated notebooks in <ahref="https://mybinder.org">MyBinder</a></p>
<ul>
<li><code>master</code> branch of diffsharp/diffsharp.github.io: <ahref="https://mybinder.org/v2/gh/diffsharp/diffsharp.github.io/master"><imgsrc="https://mybinder.org/badge_logo.svg" alt="Binder" /></a></li>
</ul>
<h1><aname="Generating-docs" class="anchor" href="#Generating-docs">Generating docs</a></h1>
<p>To iterate on docs (requires evaluation off since DLLs get locked)</p>
<preclass="fssnip highlighted"><codelang="fsharp"><spanclass="id">dotnet</span><spanclass="id">fsdocs</span><spanclass="id">watch</span>
</code></pre>
<p>To use a local build of FSharp.Formatting:</p>
<preclass="fssnip highlighted"><codelang="fsharp"><spanclass="id">git</span><spanclass="id">clone</span><spanclass="id">https</span><spanclass="pn">:</span><spanclass="c">//github.com/fsprojects/FSharp.Formatting ../FSharp.Formatting</span>
<spanclass="id">pushd</span><spanclass="o">..</span>
<spanclass="pn">.</span>
<spanclass="id">popd</span>
</code></pre>
<p>Then:</p>
<preclass="fssnip highlighted"><codelang="fsharp"><spanclass="o">..</span>
<spanclass="o">..</span>
</code></pre>
<h2><aname="Generated-Notebooks" class="anchor" href="#Generated-Notebooks">Generated Notebooks</a></h2>
<p>Notebooks are generated for all .md and .fsx files under docs as part of the build.</p>
<ul>
<li><p>Dockerfile - see <ahref="https://github.com/dotnet/interactive/blob/master/docs/CreateBinder.md">https://github.com/dotnet/interactive/blob/master/docs/CreateBinder.md</a></p></li>
<li>NuGet.config - likewise</li>
</ul>
<p>See MyBinder for creating URLs</p>


</div>
</div>
<divclass="row">
<divclass="span3"></div>
<divclass="span9">
<hr>
<pstyle="height:50px; display: table-cell; vertical-align: bottom;">© Copyright 2021, DiffSharp Contributors.</p>
<br>
</div>
</div>
</div>
<!-- BEGIN SEARCH BOX: this adds support for the search box -->
<linkrel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.css" />
<scripttype="text/javascript">varfsdocs_search_baseurl='https://diffsharp.github.io/'</script>
<scripttype="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/lunr.js/2.3.8/lunr.min.js"></script>
<scripttype="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.min.js"></script>
<scripttype="text/javascript" src="https://diffsharp.github.io/content/fsdocs-search.js"></script>
<!-- END SEARCH BOX: this adds support for the search box -->
</body>
</html>