Skip to content

Commit b8cbfdd

Browse files
Update docs
1 parent 459c3eb commit b8cbfdd

File tree

90 files changed

+1076
-164
lines changed

Some content is hidden

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

90 files changed

+1076
-164
lines changed

docs/_static/css/custom.css

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ p {
33
}
44

55
.wy-nav-content {
6-
max-width: 1000px ;
6+
max-width: 1100px ;
77
}
88

99

@@ -238,3 +238,16 @@ dd {
238238
font-size: 87.5%;
239239
}
240240

241+
img.map-adapt {
242+
position: absolute;
243+
max-width: none;
244+
transform-origin: left top;
245+
-webkit-transform: scale(0.5);
246+
-ms-transform: scale(0.5);
247+
transform: scale(0.5);
248+
height: unset!important;
249+
}
250+
251+
#selecting-the-right-domain-adaptation-model {
252+
padding-bottom: 600px;
253+
}

docs/_static/images/carto4.png

427 KB
Loading

docs/contents.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,14 @@
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" role="heading"><span class="caption-text">Tutorials</span></p>
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="map.html">Choosing the right algorithm</a></li>
52+
</ul>
4953
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5054
<ul>
5155
<li class="toctree-l1"><a class="reference internal" href="#adapt-feature-based">Feature-based</a><ul>
52-
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.feature_based.FE.html">FE</a></li>
56+
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.feature_based.FA.html">FA</a></li>
5357
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.feature_based.CORAL.html">CORAL</a></li>
5458
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.feature_based.SA.html">SA</a></li>
5559
<li class="toctree-l2"><a class="reference internal" href="generated/adapt.feature_based.fMMD.html">fMMD</a></li>
@@ -260,8 +264,8 @@ <h1>ADAPT<a class="headerlink" href="#adapt" title="Permalink to this headline">
260264
<col style="width: 90%" />
261265
</colgroup>
262266
<tbody>
263-
<tr class="row-odd"><td><p><a class="reference internal" href="generated/adapt.feature_based.FE.html#adapt.feature_based.FE" title="adapt.feature_based.FE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">feature_based.FE</span></code></a>([estimator, Xt, yt, copy, ...])</p></td>
264-
<td><p>FE: Frustratingly Easy Domain Adaptation.</p></td>
267+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/adapt.feature_based.FA.html#adapt.feature_based.FA" title="adapt.feature_based.FA"><code class="xref py py-obj docutils literal notranslate"><span class="pre">feature_based.FA</span></code></a>([estimator, Xt, yt, copy, ...])</p></td>
268+
<td><p>FA: Feature Augmentation.</p></td>
265269
</tr>
266270
<tr class="row-even"><td><p><a class="reference internal" href="generated/adapt.feature_based.CORAL.html#adapt.feature_based.CORAL" title="adapt.feature_based.CORAL"><code class="xref py py-obj docutils literal notranslate"><span class="pre">feature_based.CORAL</span></code></a>([estimator, Xt, ...])</p></td>
267271
<td><p>CORAL: CORrelation ALignment</p></td>

docs/examples/Classification.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,14 @@
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" role="heading"><span class="caption-text">Tutorials</span></p>
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="../map.html">Choosing the right algorithm</a></li>
52+
</ul>
4953
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5054
<ul>
5155
<li class="toctree-l1"><a class="reference internal" href="../contents.html#adapt-feature-based">Feature-based</a><ul>
52-
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.FE.html">FE</a></li>
56+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.FA.html">FA</a></li>
5357
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.CORAL.html">CORAL</a></li>
5458
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.SA.html">SA</a></li>
5559
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.fMMD.html">fMMD</a></li>
@@ -469,8 +473,8 @@
469473
</style>
470474
<section id="Classification">
471475
<h1>Classification<a class="headerlink" href="#Classification" title="Permalink to this headline"></a></h1>
472-
<div class="btn btn-notebook" role="button"><p><img alt="e7039483b2dc4ea18ee11f560be137a4" 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>
473-
</div><div class="btn btn-notebook" role="button"><p><img alt="b78330d4ef564a759835480a763370d1" 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>
476+
<div class="btn btn-notebook" role="button"><p><img alt="7e5febbae9be4cb49a22890f1a8ef47d" 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>
477+
</div><div class="btn btn-notebook" role="button"><p><img alt="6600b9179aab4842916326eb2be34ace" 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>
474478
</div><p>You will find here the application of DA methods from the ADAPT package on a simple two dimensional DA classification problem.</p>
475479
<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>
476480
<div class="nbinput nblast docutils container">

docs/examples/Multi_fidelity.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,14 @@
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" role="heading"><span class="caption-text">Tutorials</span></p>
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="../map.html">Choosing the right algorithm</a></li>
52+
</ul>
4953
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5054
<ul>
5155
<li class="toctree-l1"><a class="reference internal" href="../contents.html#adapt-feature-based">Feature-based</a><ul>
52-
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.FE.html">FE</a></li>
56+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.FA.html">FA</a></li>
5357
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.CORAL.html">CORAL</a></li>
5458
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.SA.html">SA</a></li>
5559
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.fMMD.html">fMMD</a></li>
@@ -469,8 +473,8 @@
469473
</style>
470474
<section id="Multi-Fidelity">
471475
<h1>Multi-Fidelity<a class="headerlink" href="#Multi-Fidelity" title="Permalink to this headline"></a></h1>
472-
<div class="btn btn-notebook" role="button"><p><img alt="f630b8d69d7647e986fa8aeb2411c923" src="../_images/colab_logo_32px.png" /> <a class="reference external" href="https://colab.research.google.com/drive/1Cc9TVY_Tl_boVzZDNisQnqe6Qx78svqe?usp=sharing">Run in Google Colab</a></p>
473-
</div><div class="btn btn-notebook" role="button"><p><img alt="c68caa818b9847faa67ab0b96d821b88" src="../_images/github_logo_32px.png" /> <a class="reference external" href="https://github.com/adapt-python/notebooks/blob/d0364973c642ea4880756cef4e9f2ee8bb5e8495/Multi_fidelity.ipynb">View on GitHub</a></p>
476+
<div class="btn btn-notebook" role="button"><p><img alt="39fb27f4651d4fbf9ef92e084815a7a7" src="../_images/colab_logo_32px.png" /> <a class="reference external" href="https://colab.research.google.com/drive/1Cc9TVY_Tl_boVzZDNisQnqe6Qx78svqe?usp=sharing">Run in Google Colab</a></p>
477+
</div><div class="btn btn-notebook" role="button"><p><img alt="16a9427b4d9a458a893dff0faa024dd9" src="../_images/github_logo_32px.png" /> <a class="reference external" href="https://github.com/adapt-python/notebooks/blob/d0364973c642ea4880756cef4e9f2ee8bb5e8495/Multi_fidelity.ipynb">View on GitHub</a></p>
474478
</div><p>The following example is a 1D regression multi-fidelity issue. Blue points are low fidelity observations and orange points are high fidelity observations. The goal is to use both datasets to learn the task on the [0, 1] interval.</p>
475479
<p>To tackle this challenge, we use here the parameter-based method: <a class="reference external" href="#RegularTransferNN">RegularTransferNN</a></p>
476480
<div class="nbinput nblast docutils container">

docs/examples/Regression.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,14 @@
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" role="heading"><span class="caption-text">Tutorials</span></p>
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="../map.html">Choosing the right algorithm</a></li>
52+
</ul>
4953
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5054
<ul>
5155
<li class="toctree-l1"><a class="reference internal" href="../contents.html#adapt-feature-based">Feature-based</a><ul>
52-
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.FE.html">FE</a></li>
56+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.FA.html">FA</a></li>
5357
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.CORAL.html">CORAL</a></li>
5458
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.SA.html">SA</a></li>
5559
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.fMMD.html">fMMD</a></li>
@@ -469,8 +473,8 @@
469473
</style>
470474
<section id="Toy-Regression">
471475
<h1>Toy Regression<a class="headerlink" href="#Toy-Regression" title="Permalink to this headline"></a></h1>
472-
<div class="btn btn-notebook" role="button"><p><img alt="4401e0ae9ac7495f8fefef6c5fcfa2b7" src="../_images/colab_logo_32px.png" /> <a class="reference external" href="https://colab.research.google.com/drive/1adhqoV6b0uEavLDmMfkiwtRjam0DrXux?usp=sharing">Run in Google Colab</a></p>
473-
</div><div class="btn btn-notebook" role="button"><p><img alt="ee6cd43caa46488cb94b7936201e55e2" src="../_images/github_logo_32px.png" /> <a class="reference external" href="https://github.com/adapt-python/notebooks/blob/d0364973c642ea4880756cef4e9f2ee8bb5e8495/Regression.ipynb">View on GitHub</a></p>
476+
<div class="btn btn-notebook" role="button"><p><img alt="e424096f38164c73a44b40c56b827341" src="../_images/colab_logo_32px.png" /> <a class="reference external" href="https://colab.research.google.com/drive/1adhqoV6b0uEavLDmMfkiwtRjam0DrXux?usp=sharing">Run in Google Colab</a></p>
477+
</div><div class="btn btn-notebook" role="button"><p><img alt="ce200f7c0da44b108ad1b64974134025" src="../_images/github_logo_32px.png" /> <a class="reference external" href="https://github.com/adapt-python/notebooks/blob/d0364973c642ea4880756cef4e9f2ee8bb5e8495/Regression.ipynb">View on GitHub</a></p>
474478
</div><p>You will find here the application of DA methods from the ADAPT package on a simple one dimensional DA regression problem.</p>
475479
<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 selected methods:</p>
476480
<div class="nbinput nblast docutils container">

docs/examples/Rotation.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,14 @@
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" role="heading"><span class="caption-text">Tutorials</span></p>
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="../map.html">Choosing the right algorithm</a></li>
52+
</ul>
4953
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5054
<ul>
5155
<li class="toctree-l1"><a class="reference internal" href="../contents.html#adapt-feature-based">Feature-based</a><ul>
52-
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.FE.html">FE</a></li>
56+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.FA.html">FA</a></li>
5357
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.CORAL.html">CORAL</a></li>
5458
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.SA.html">SA</a></li>
5559
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.fMMD.html">fMMD</a></li>
@@ -469,8 +473,8 @@
469473
</style>
470474
<section id="Rotation">
471475
<h1>Rotation<a class="headerlink" href="#Rotation" title="Permalink to this headline"></a></h1>
472-
<div class="btn btn-notebook" role="button"><p><img alt="c4905c3b059b4f3199bb551002e9bcb3" src="../_images/colab_logo_32px.png" /> <a class="reference external" href="https://colab.research.google.com/drive/1XePW12UF80PKzvLu9cyRJKWQoZIxk_J2?usp=sharing">Run in Google Colab</a></p>
473-
</div><div class="btn btn-notebook" role="button"><p><img alt="2e63337f1dd44d008c297988ce4446d2" src="../_images/github_logo_32px.png" /> <a class="reference external" href="https://github.com/adapt-python/notebooks/blob/d0364973c642ea4880756cef4e9f2ee8bb5e8495/Rotation.ipynb">View on GitHub</a></p>
476+
<div class="btn btn-notebook" role="button"><p><img alt="51da7c6cd45d41e082eaa888754ce460" src="../_images/colab_logo_32px.png" /> <a class="reference external" href="https://colab.research.google.com/drive/1XePW12UF80PKzvLu9cyRJKWQoZIxk_J2?usp=sharing">Run in Google Colab</a></p>
477+
</div><div class="btn btn-notebook" role="button"><p><img alt="452537d909714f6aa4ad1bb8a228b1f3" src="../_images/github_logo_32px.png" /> <a class="reference external" href="https://github.com/adapt-python/notebooks/blob/d0364973c642ea4880756cef4e9f2ee8bb5e8495/Rotation.ipynb">View on GitHub</a></p>
474478
</div><div class="nbinput nblast docutils container">
475479
<div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[2]:
476480
</pre></div>

docs/examples/Two_moons.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,14 @@
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" role="heading"><span class="caption-text">Tutorials</span></p>
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="../map.html">Choosing the right algorithm</a></li>
52+
</ul>
4953
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5054
<ul>
5155
<li class="toctree-l1"><a class="reference internal" href="../contents.html#adapt-feature-based">Feature-based</a><ul>
52-
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.FE.html">FE</a></li>
56+
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.FA.html">FA</a></li>
5357
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.CORAL.html">CORAL</a></li>
5458
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.SA.html">SA</a></li>
5559
<li class="toctree-l2"><a class="reference internal" href="../generated/adapt.feature_based.fMMD.html">fMMD</a></li>
@@ -469,8 +473,8 @@
469473
</style>
470474
<section id="Two-Moons">
471475
<h1>Two Moons<a class="headerlink" href="#Two-Moons" title="Permalink to this headline"></a></h1>
472-
<div class="btn btn-notebook" role="button"><p><img alt="f370479d0d9548a6b065dee562e1a44a" src="../_images/colab_logo_32px.png" /> <a class="reference external" href="https://colab.research.google.com/drive/1Tz-TIkHI8ashHP90Im6D3tMjZ3lkR7s6?usp=sharing">Run in Google Colab</a></p>
473-
</div><div class="btn btn-notebook" role="button"><p><img alt="af0be599c0dd4c5b8d5a45ec1b5f0a7e" src="../_images/github_logo_32px.png" /> <a class="reference external" href="https://github.com/adapt-python/notebooks/blob/d0364973c642ea4880756cef4e9f2ee8bb5e8495/Two_moons.ipynb">View on GitHub</a></p>
476+
<div class="btn btn-notebook" role="button"><p><img alt="92321d0ef1d54e1fb424a825284362a2" src="../_images/colab_logo_32px.png" /> <a class="reference external" href="https://colab.research.google.com/drive/1Tz-TIkHI8ashHP90Im6D3tMjZ3lkR7s6?usp=sharing">Run in Google Colab</a></p>
477+
</div><div class="btn btn-notebook" role="button"><p><img alt="698097286ed34c5a8ee3b33e9d257483" src="../_images/github_logo_32px.png" /> <a class="reference external" href="https://github.com/adapt-python/notebooks/blob/d0364973c642ea4880756cef4e9f2ee8bb5e8495/Two_moons.ipynb">View on GitHub</a></p>
474478
</div><p>The following example is a binary classification domain adaptation issue. The goal is to learn the classification task on the target data (black points) knowing only the labels on the source data (red and blue points).</p>
475479
<p>The following methods are being tested:</p>
476480
<ul class="simple">

0 commit comments

Comments
 (0)