Skip to content

Commit 0227337

Browse files
github-actions[bot]github-actions[bot]
committed
Update docs
1 parent 524bd13 commit 0227337

File tree

70 files changed

+2306
-590
lines changed

Some content is hidden

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

70 files changed

+2306
-590
lines changed

‎docs/_images/wdgrl.png

73.9 KB
Loading

‎docs/_static/images/wdgrl.png

73.9 KB
Loading

‎docs/_static/js/custom.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,6 @@ function changeColor() {
8989

9090
changeColor();
9191
attributes();
92-
changeLinks();
92+
//changeLinks();
9393
//addLinks();
9494

‎docs/_static/gallery-binder.css renamed to ‎docs/_static/sg_gallery-binder.css

File renamed without changes.

‎docs/_static/gallery-dataframe.css renamed to ‎docs/_static/sg_gallery-dataframe.css

File renamed without changes.

‎docs/_static/gallery-rendered-html.css renamed to ‎docs/_static/sg_gallery-rendered-html.css

File renamed without changes.

‎docs/_static/gallery.css renamed to ‎docs/_static/sg_gallery.css

File renamed without changes.

‎docs/contents.html

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<title>ADAPT &mdash; adapt 0.1.0 documentation</title>
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
10-
<link rel="stylesheet" href="_static/gallery.css" type="text/css" />
10+
<link rel="stylesheet" href="_static/sg_gallery.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
1212
<!--[if lt IE 9]>
1313
<script src="_static/js/html5shiv.min.js"></script>
@@ -40,15 +40,15 @@
4040
<input type="hidden" name="area" value="default" />
4141
</form>
4242
</div>
43-
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
44-
<p class="caption"><span class="caption-text">Installation</span></p>
43+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
44+
<p class="caption" role="heading"><span class="caption-text">Installation</span></p>
4545
<ul>
4646
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
4747
<li class="toctree-l1"><a class="reference internal" href="https://github.com/adapt-python/adapt">Github</a></li>
4848
</ul>
49-
<p class="caption"><span class="caption-text">API Documentation</span></p>
49+
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5050
<ul>
51-
<li class="toctree-l1"><a class="reference internal" href="##adapt-feature-based">Feature-based</a><ul>
51+
<li class="toctree-l1"><a class="reference internal" href="#adapt-feature-based">Feature-based</a><ul>
5252
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.feature_based.BaseDeepFeature.html">BaseDeepFeature</a></li>
5353
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.feature_based.FE.html">FE</a></li>
5454
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.feature_based.CORAL.html">CORAL</a></li>
@@ -58,32 +58,45 @@
5858
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.feature_based.mSDA.html">mSDA</a></li>
5959
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.feature_based.MCD.html">MCD</a></li>
6060
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.feature_based.MDD.html">MDD</a></li>
61+
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.feature_based.WDGRL.html">WDGRL</a></li>
6162
</ul>
6263
</li>
63-
<li class="toctree-l1"><a class="reference internal" href="##adapt-instance-based">Instance-based</a><ul>
64+
<li class="toctree-l1"><a class="reference internal" href="#adapt-instance-based">Instance-based</a><ul>
6465
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.instance_based.KLIEP.html">KLIEP</a></li>
6566
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.instance_based.KMM.html">KMM</a></li>
6667
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.instance_based.TrAdaBoost.html">TrAdaBoost</a></li>
6768
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.instance_based.TrAdaBoostR2.html">TrAdaBoostR2</a></li>
6869
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.instance_based.TwoStageTrAdaBoostR2.html">TwoStageTrAdaBoostR2</a></li>
6970
</ul>
7071
</li>
71-
<li class="toctree-l1"><a class="reference internal" href="##adapt-parameter-based">Parameter-based</a><ul>
72+
<li class="toctree-l1"><a class="reference internal" href="#adapt-parameter-based">Parameter-based</a><ul>
7273
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.parameter_based.RegularTransferLR.html">RegularTransferLR</a></li>
7374
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.parameter_based.RegularTransferLC.html">RegularTransferLC</a></li>
7475
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.parameter_based.RegularTransferNN.html">RegularTransferNN</a></li>
7576
</ul>
7677
</li>
78+
<li class="toctree-l1"><a class="reference internal" href="#adapt-utils">Utility Functions</a><ul>
79+
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.utils.check_arrays.html">check_arrays</a></li>
80+
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.utils.check_one_array.html">check_one_array</a></li>
81+
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.utils.check_estimator.html">check_estimator</a></li>
82+
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.utils.check_network.html">check_network</a></li>
83+
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.utils.get_default_encoder.html">get_default_encoder</a></li>
84+
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.utils.get_default_task.html">get_default_task</a></li>
85+
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.utils.get_default_discriminator.html">get_default_discriminator</a></li>
86+
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.utils.GradientHandler.html">GradientHandler</a></li>
87+
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.utils.make_classification_da.html">make_classification_da</a></li>
88+
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.utils.make_regression_da.html">make_regression_da</a></li>
7789
</ul>
78-
<p class="caption"><span class="caption-text">Examples Gallery</span></p>
90+
</li>
91+
</ul>
92+
<p class="caption" role="heading"><span class="caption-text">Examples Gallery</span></p>
7993
<ul>
8094
<li class="toctree-l1"><a class="reference internal" href="examples/Classification.html">Classification</a><ul>
8195
<li class="toctree-l2"><a class="reference internal" href="examples/Classification.html#Experimental-Setup">Experimental Setup</a></li>
8296
<li class="toctree-l2"><a class="reference internal" href="examples/Classification.html#Src-Only">Src Only</a></li>
8397
<li class="toctree-l2"><a class="reference internal" href="examples/Classification.html#mSDA">mSDA</a></li>
8498
<li class="toctree-l2"><a class="reference internal" href="examples/Classification.html#DANN">DANN</a></li>
8599
<li class="toctree-l2"><a class="reference internal" href="examples/Classification.html#Instance-Based">Instance Based</a></li>
86-
<li class="toctree-l2"><a class="reference internal" href="examples/Classification.html#See-also">See also</a></li>
87100
</ul>
88101
</li>
89102
<li class="toctree-l1"><a class="reference internal" href="examples/Two_moons.html">Two Moons</a><ul>
@@ -113,12 +126,10 @@
113126
<li class="toctree-l2"><a class="reference internal" href="examples/Regression.html#CORAL">CORAL</a></li>
114127
<li class="toctree-l2"><a class="reference internal" href="examples/Regression.html#TrAdaBoostR2">TrAdaBoostR2</a></li>
115128
<li class="toctree-l2"><a class="reference internal" href="examples/Regression.html#RegularTransferNN">RegularTransferNN</a></li>
116-
<li class="toctree-l2"><a class="reference internal" href="examples/Regression.html#See-also">See also</a></li>
117129
</ul>
118130
</li>
119131
<li class="toctree-l1"><a class="reference internal" href="examples/sample_bias.html">Sample Bias 1D</a><ul>
120132
<li class="toctree-l2"><a class="reference internal" href="examples/sample_bias.html#Setup">Setup</a></li>
121-
<li class="toctree-l2"><a class="reference internal" href="examples/sample_bias.html#Source-Only">Source Only</a></li>
122133
<li class="toctree-l2"><a class="reference internal" href="examples/sample_bias.html#KMM">KMM</a></li>
123134
<li class="toctree-l2"><a class="reference internal" href="examples/sample_bias.html#KLIEP">KLIEP</a></li>
124135
</ul>
@@ -140,7 +151,7 @@
140151
</ul>
141152
</li>
142153
</ul>
143-
154+
144155
</div>
145156
</div>
146157
</nav>
@@ -254,6 +265,9 @@ <h1>ADAPT<a class="headerlink" href="#adapt" title="Permalink to this headline">
254265
<tr class="row-odd"><td><p><a class="reference internal" href="generated/adapt.feature_based.MDD.html#adapt.feature_based.MDD" title="adapt.feature_based.MDD"><code class="xref py py-obj docutils literal notranslate"><span class="pre">feature_based.MDD</span></code></a>([encoder, task, ...])</p></td>
255266
<td><p>MDD: Margin Disparity Discrepancy is a feature-based domain adaptation method originally introduced for unsupervised classification DA.</p></td>
256267
</tr>
268+
<tr class="row-even"><td><p><a class="reference internal" href="generated/adapt.feature_based.WDGRL.html#adapt.feature_based.WDGRL" title="adapt.feature_based.WDGRL"><code class="xref py py-obj docutils literal notranslate"><span class="pre">feature_based.WDGRL</span></code></a>([encoder, task, ...])</p></td>
269+
<td><p>WDGRL (Wasserstein Distance Guided Representation Learning) is an unsupervised domain adaptation method on the model of the <span class="xref std std-ref">DANN</span>.</p></td>
270+
</tr>
257271
</tbody>
258272
</table>
259273
</section>

‎docs/examples/Classification.html

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<title>Classification &mdash; adapt 0.1.0 documentation</title>
88
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
10-
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
10+
<link rel="stylesheet" href="../_static/sg_gallery.css" type="text/css" />
1111
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
1212
<!--[if lt IE 9]>
1313
<script src="../_static/js/html5shiv.min.js"></script>
@@ -40,13 +40,13 @@
4040
<input type="hidden" name="area" value="default" />
4141
</form>
4242
</div>
43-
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
44-
<p class="caption"><span class="caption-text">Installation</span></p>
43+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
44+
<p class="caption" role="heading"><span class="caption-text">Installation</span></p>
4545
<ul>
4646
<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li>
4747
<li class="toctree-l1"><a class="reference internal" href="https://github.com/adapt-python/adapt">Github</a></li>
4848
</ul>
49-
<p class="caption"><span class="caption-text">API Documentation</span></p>
49+
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5050
<ul>
5151
<li class="toctree-l1"><a class="reference internal" href="../contents.html#adapt-feature-based">Feature-based</a><ul>
5252
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.BaseDeepFeature.html">BaseDeepFeature</a></li>
@@ -58,6 +58,7 @@
5858
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.mSDA.html">mSDA</a></li>
5959
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.MCD.html">MCD</a></li>
6060
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.MDD.html">MDD</a></li>
61+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.WDGRL.html">WDGRL</a></li>
6162
</ul>
6263
</li>
6364
<li class="toctree-l1"><a class="reference internal" href="../contents.html#adapt-instance-based">Instance-based</a><ul>
@@ -74,16 +75,28 @@
7475
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.parameter_based.RegularTransferNN.html">RegularTransferNN</a></li>
7576
</ul>
7677
</li>
78+
<li class="toctree-l1"><a class="reference internal" href="../contents.html#adapt-utils">Utility Functions</a><ul>
79+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.utils.check_arrays.html">check_arrays</a></li>
80+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.utils.check_one_array.html">check_one_array</a></li>
81+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.utils.check_estimator.html">check_estimator</a></li>
82+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.utils.check_network.html">check_network</a></li>
83+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.utils.get_default_encoder.html">get_default_encoder</a></li>
84+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.utils.get_default_task.html">get_default_task</a></li>
85+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.utils.get_default_discriminator.html">get_default_discriminator</a></li>
86+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.utils.GradientHandler.html">GradientHandler</a></li>
87+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.utils.make_classification_da.html">make_classification_da</a></li>
88+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.utils.make_regression_da.html">make_regression_da</a></li>
7789
</ul>
78-
<p class="caption"><span class="caption-text">Examples Gallery</span></p>
90+
</li>
91+
</ul>
92+
<p class="caption" role="heading"><span class="caption-text">Examples Gallery</span></p>
7993
<ul>
8094
<li class="toctree-l1"><a class="reference internal" href="#">Classification</a><ul>
81-
<li class="toctree-l2"><a class="reference internal" href="##Experimental-Setup">Experimental Setup</a></li>
82-
<li class="toctree-l2"><a class="reference internal" href="##Src-Only">Src Only</a></li>
83-
<li class="toctree-l2"><a class="reference internal" href="##mSDA">mSDA</a></li>
84-
<li class="toctree-l2"><a class="reference internal" href="##DANN">DANN</a></li>
85-
<li class="toctree-l2"><a class="reference internal" href="##Instance-Based">Instance Based</a></li>
86-
<li class="toctree-l2"><a class="reference internal" href="##See-also">See also</a></li>
95+
<li class="toctree-l2"><a class="reference internal" href="#Experimental-Setup">Experimental Setup</a></li>
96+
<li class="toctree-l2"><a class="reference internal" href="#Src-Only">Src Only</a></li>
97+
<li class="toctree-l2"><a class="reference internal" href="#mSDA">mSDA</a></li>
98+
<li class="toctree-l2"><a class="reference internal" href="#DANN">DANN</a></li>
99+
<li class="toctree-l2"><a class="reference internal" href="#Instance-Based">Instance Based</a></li>
87100
</ul>
88101
</li>
89102
<li class="toctree-l1"><a class="reference internal" href="Two_moons.html">Two Moons</a><ul>
@@ -113,12 +126,10 @@
113126
<li class="toctree-l2"><a class="reference internal" href="Regression.html#CORAL">CORAL</a></li>
114127
<li class="toctree-l2"><a class="reference internal" href="Regression.html#TrAdaBoostR2">TrAdaBoostR2</a></li>
115128
<li class="toctree-l2"><a class="reference internal" href="Regression.html#RegularTransferNN">RegularTransferNN</a></li>
116-
<li class="toctree-l2"><a class="reference internal" href="Regression.html#See-also">See also</a></li>
117129
</ul>
118130
</li>
119131
<li class="toctree-l1"><a class="reference internal" href="sample_bias.html">Sample Bias 1D</a><ul>
120132
<li class="toctree-l2"><a class="reference internal" href="sample_bias.html#Setup">Setup</a></li>
121-
<li class="toctree-l2"><a class="reference internal" href="sample_bias.html#Source-Only">Source Only</a></li>
122133
<li class="toctree-l2"><a class="reference internal" href="sample_bias.html#KMM">KMM</a></li>
123134
<li class="toctree-l2"><a class="reference internal" href="sample_bias.html#KLIEP">KLIEP</a></li>
124135
</ul>
@@ -140,7 +151,7 @@
140151
</ul>
141152
</li>
142153
</ul>
143-
154+
144155
</div>
145156
</div>
146157
</nav>
@@ -436,8 +447,8 @@
436447
</style>
437448
<section id="Classification">
438449
<h1>Classification<a class="headerlink" href="#Classification" title="Permalink to this headline"></a></h1>
439-
<div class="btn btn-notebook" role="button"><p><img alt="09bc92d00b19480cb23f3b0fe9c986ff" src="../_images/colab_logo_32px.png" /> <a class="reference external" href="https://colab.research.google.com/drive/1ANQUix9Y6V4RXu-vAaCFGmU979d5m4bO?usp=sharing">Run in Google Colab</a></p>
440-
</div><div class="btn btn-notebook" role="button"><p><img alt="d524f1683c254916b86993a49a4e365e" src="../_images/github_logo_32px.png" /> <a class="reference external" href="https://github.com/adapt-python/notebooks/blob/d0364973c642ea4880756cef4e9f2ee8bb5e8495/Classification.ipynb">View on GitHub</a></p>
450+
<div class="btn btn-notebook" role="button"><p><img alt="aaf720d69a4845cfb3f988129bcfeff6" src="../_images/colab_logo_32px.png" /> <a class="reference external" href="https://colab.research.google.com/drive/1ANQUix9Y6V4RXu-vAaCFGmU979d5m4bO?usp=sharing">Run in Google Colab</a></p>
451+
</div><div class="btn btn-notebook" role="button"><p><img alt="e63355d9179b498cbdca4110c5e996cd" src="../_images/github_logo_32px.png" /> <a class="reference external" href="https://github.com/adapt-python/notebooks/blob/d0364973c642ea4880756cef4e9f2ee8bb5e8495/Classification.ipynb">View on GitHub</a></p>
441452
</div><p>You will find here the application of DA methods from the ADAPT package on a simple two dimensional DA classification problem.</p>
442453
<p>First we import packages needed in the following. We will use <code class="docutils literal notranslate"><span class="pre">matplotlib</span> <span class="pre">Animation</span></code> tools in order to get a visual understanding of the mselected methods:</p>
443454
<div class="nbinput nblast docutils container">

0 commit comments

Comments
 (0)