Merge pull request #29 from antoinedemathelin/master

docs: Add flowchart

Author: antoinedemathelin

adapt/feature_based/__init__.py

@@ -2,7 +2,7 @@
 Feature-Based Methods Module
 """
 
-from ._fe import FE
+from ._fa import FA
 from ._coral import CORAL
 from ._dann import DANN
 from ._adda import ADDA
@@ -15,5 +15,5 @@
 from ._fmmd import fMMD
 from ._ccsa import CCSA
 
-__all__ = ["FE", "CORAL", "DeepCORAL", "ADDA", "DANN",
+__all__ = ["FA", "CORAL", "DeepCORAL", "ADDA", "DANN",
            "MCD", "MDD", "WDGRL", "CDAN", "SA", "fMMD", "CCSA"]

adapt/feature_based/_fe.py renamed to adapt/feature_based/_fa.py

@@ -12,11 +12,11 @@
 
 
 @make_insert_doc(supervised=True)
-class FE(BaseAdaptEstimator):
+class FA(BaseAdaptEstimator):
     """
-    FE: Frustratingly Easy Domain Adaptation.
+    FA: Feature Augmentation.
 
-    FE consists in a feature augmentation method
+    FA consists in a feature augmentation method
     where each input feature vector is augmented as follow:
 
     - Source input feature vectors Xs are transformed into (Xs, **0**, Xs).
@@ -37,7 +37,7 @@ class FE(BaseAdaptEstimator):
     This feature-based method uses a few labeled target data and belongs to
     "supervised" domain adaptation methods.
 
-    As FE consists only in a preprocessing step, any kind of estimator
+    As FA consists only in a preprocessing step, any kind of estimator
     can be used to learn the task. This method handles both regression
     and classification tasks.
 
@@ -73,13 +73,13 @@ class FE(BaseAdaptEstimator):
     Examples
     --------
     >>> import numpy as np
-    >>> from adapt.feature_based import FE
+    >>> from adapt.feature_based import FA
     >>> np.random.seed(0)
     >>> Xs = 0.1 * np.random.randn(100, 1) + 1.
     >>> Xt = 0.1 * np.random.randn(100, 1) + 1.
     >>> ys = 0.1 * np.random.randn(100, 1) + 0.
     >>> yt = 0.1 * np.random.randn(100, 1) + 1.
-    >>> model = FE()
+    >>> model = FA()
     >>> model.fit(Xs, ys, Xt[:10], yt[:10]);
     Augmenting feature space...
     Previous shape: (100, 1)
@@ -97,7 +97,7 @@ class FE(BaseAdaptEstimator):
 
     Notes
     -----
-    FE can be used for multi-source DA by giving list of source data
+    FA can be used for multi-source DA by giving list of source data
     for arguments Xs, ys of fit method : Xs = [Xs1, Xs2, ...],
     ys = [ys1, ys2, ...]
     """
@@ -218,7 +218,7 @@ def transform(self, X, domain="tgt"):
 
         Notes
         -----
-        As FE is an anti-symetric feature-based method, one should indicates the
+        As FA is an anti-symetric feature-based method, one should indicates the
         domain of ``X`` in order to apply the appropriate feature transformation.
         """
         X = check_array(X, allow_nd=True)

src_docs/_static/css/custom.css

@@ -3,7 +3,7 @@ p {
 }
 
 .wy-nav-content {
-    max-width: 1000px ;
+    max-width: 1100px ;
 }
 
 
@@ -238,3 +238,16 @@ dd {
 	font-size: 87.5%;
 }
 
+img.map-adapt {
+    position: absolute;
+    max-width: none;
+    transform-origin: left top;
+    -webkit-transform: scale(0.5);
+    -ms-transform: scale(0.5);
+    transform: scale(0.5);
+	height: unset!important;
+}
+
+#selecting-the-right-domain-adaptation-model {
+    padding-bottom: 600px;
+}

src_docs/_static/images/carto4.png

@@ -15,10 +15,14 @@
 <li class="toctree-l1"><a class="reference internal" href="{{ pathto("install") }}">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="https://github.com/adapt-python/adapt">Github</a></li>
 </ul>
+<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="{{ pathto("map") }}">Choosing the right algorithm</a></li>
+</ul>
 <p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="{{ pathto("contents") }}{{ contents }}{{ "adapt-feature-based" }}">Feature-based</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.feature_based.FE") }}">FE</a></li>
+<li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.feature_based.FA") }}">FA</a></li>
 <li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.feature_based.CORAL") }}">CORAL</a></li>
 <li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.feature_based.SA") }}">SA</a></li>
 <li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.feature_based.fMMD") }}">fMMD</a></li>

src_docs/_templates/layout.html

@@ -0,0 +1,47 @@
+
+<img class="map-adapt" src="_static/images/carto4.png" usemap="#image-map">
+
+<map name="image-map">
+    <area target="" alt="Adapt" title="Adapt" href="https://adapt-python.github.io/adapt/" coords="534,101,151,72" shape="rect">
+    <area target="" alt="RegularTransferLR" title="RegularTransferLR" href="https://adapt-python.github.io/adapt/generated/adapt.parameter_based.RegularTransferLR.html" coords="1004,41,1174,67" shape="rect">
+    <area target="" alt="RegularTransferLC" title="RegularTransferLC" href="https://adapt-python.github.io/adapt/generated/adapt.parameter_based.RegularTransferLC.html" coords="1003,72,1169,90" shape="rect">
+    <area target="" alt="RegularTransferNN" title="RegularTransferNN" href="https://adapt-python.github.io/adapt/generated/adapt.parameter_based.RegularTransferNN.html" coords="1409,148,1582,171" shape="rect">
+    <area target="" alt="TransferTreeRegressor" title="TransferTreeRegressor" href="https://adapt-python.github.io/adapt/generated/adapt.parameter_based.TransferTreeRegressor.html" coords="1377,34,1573,58" shape="rect">
+    <area target="" alt="TransferTreeClassifier" title="TransferTreeClassifier" href="https://adapt-python.github.io/adapt/generated/adapt.parameter_based.TransferTreeClassifier.html" coords="1377,60,1568,78" shape="rect">
+    <area target="" alt="TransferForestClassifier" title="TransferForestClassifier" href="https://adapt-python.github.io/adapt/generated/adapt.parameter_based.TransferForest.html" coords="1379,88,1515,104" shape="rect">
+    <area target="" alt="FineTuning" title="FineTuning" href="https://adapt-python.github.io/adapt/generated/adapt.parameter_based.FineTuning.html" coords="1409,177,1508,194" shape="rect">
+    <area target="" alt="PRED" title="PRED" href="https://adapt-python.github.io/adapt/generated/adapt.parameter_based.PRED.html" coords="1397,270,1446,290" shape="rect">
+    <area target="" alt="LinInt" title="LinInt" href="https://adapt-python.github.io/adapt/generated/adapt.parameter_based.LinInt.html" coords="1395,293,1450,315" shape="rect">
+    <area target="" alt="TrAdaBoostR2" title="TrAdaBoostR2" href="https://adapt-python.github.io/adapt/generated/adapt.instance_based.TrAdaBoostR2.html" coords="973,288,1105,307" shape="rect">
+    <area target="" alt="TwoStageTrAdaBoostR2" title="TwoStageTrAdaBoostR2" href="https://adapt-python.github.io/adapt/generated/adapt.instance_based.TwoStageTrAdaBoostR2.html" coords="974,315,1186,330" shape="rect">
+    <area target="" alt="TrAdaBoost" title="TrAdaBoost" href="https://adapt-python.github.io/adapt/generated/adapt.instance_based.TrAdaBoost.html" coords="948,419,1057,438" shape="rect">
+    <area target="" alt="CCSA" title="CCSA" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.CCSA.html" coords="950,445,1004,463" shape="rect">
+    <area target="" alt="FADA" title="FADA" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.FADA.html" coords="950,468,1013,488" shape="rect">
+    <area target="" alt="BalancedWeighting" title="BalancedWeighting" href="https://adapt-python.github.io/adapt/generated/adapt.instance_based.BalancedWeighting.html" coords="1439,378,1609,399" shape="rect">
+    <area target="" alt="FA" title="FA" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.FA.html" coords="1437,405,1473,422" shape="rect">
+    <area target="" alt="WANN" title="WANN" href="https://adapt-python.github.io/adapt/generated/adapt.instance_based.WANN.html" coords="1437,428,1513,451" shape="rect">
+    <area target="" alt="GDM" title="GDM" href="https://adapt-python.github.io/adapt/generated/adapt.instance_based.GDM.html" coords="1598,532,1653,551" shape="rect">
+    <area target="" alt="MME" title="MME" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.MME.html" coords="1609,677,1669,700" shape="rect">
+    <area target="" alt="SSDANN" title="SSDANN" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.SSDANN.html" coords="1607,705,1704,723" shape="rect">
+    <area target="" alt="LDM" title="LDM" href="https://adapt-python.github.io/adapt/generated/adapt.instance_based.LDM.html" coords="835,763,883,788" shape="rect">
+    <area target="" alt="KMM" title="KMM" href="https://adapt-python.github.io/adapt/generated/adapt.instance_based.KMM.html" coords="757,877,814,894" shape="rect">
+    <area target="" alt="KLIEP" title="KLIEP" href="https://adapt-python.github.io/adapt/generated/adapt.instance_based.KLIEP.html" coords="755,901,814,921" shape="rect">
+    <area target="" alt="NearestNeighborsWeighting" title="NearestNeighborsWeighting" href="https://adapt-python.github.io/adapt/generated/adapt.instance_based.NearestNeighborsWeighting.html" coords="750,1014,997,1036" shape="rect">
+    <area target="" alt="DANN" title="DANN" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.DANN.html" coords="1254,924,1321,944" shape="rect">
+    <area target="" alt="ADDA" title="ADDA" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.ADDA.html" coords="1254,947,1321,967" shape="rect">
+    <area target="" alt="WDGRL" title="WDGRL" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.WDGRL.html" coords="1255,975,1331,993" shape="rect">
+    <area target="" alt="DeepCORAL" title="DeepCORAL" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.DeepCORAL.html" coords="1255,997,1372,1018" shape="rect">
+    <area target="" alt="MCD" title="MCD" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.MCD.html" coords="1255,1025,1307,1043" shape="rect">
+    <area target="" alt="MDD" title="MDD" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.MDD.html" coords="1254,1050,1310,1067" shape="rect">
+    <area target="" alt="CDAN" title="CDAN" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.CDAN.html" coords="1255,1074,1314,1092" shape="rect">
+    <area target="" alt="fMMD" title="fMMD" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.fMMD.html" coords="1612,808,1678,827" shape="rect">
+    <area target="" alt="FSDA" title="FSDA" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.FSDA.html" coords="1610,834,1667,852" shape="rect">
+    <area target="" alt="FSSP" title="FSSP" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.FSSP.html" coords="1610,859,1667,875" shape="rect">
+    <area target="" alt="SA" title="SA" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.SA.html" coords="1605,917,1639,938" shape="rect">
+    <area target="" alt="TCA" title="TCA" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.TCA.html" coords="1603,945,1649,961" shape="rect">
+    <area target="" alt="JDA" title="JDA" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.JDA.html" coords="1603,968,1646,988" shape="rect">
+    <area target="" alt="CORAL" title="CORAL" href="https://adapt-python.github.io/adapt/generated/adapt.feature_based.CORAL.html" coords="1603,993,1676,1014" shape="rect">
+    <area target="" alt="SHOT" title="SHOT" href="https://adapt-python.github.io/adapt/generated/adapt.parameter_based.SHOT.html" coords="649,49,702,71" shape="rect">
+    <area target="" alt="NRC" title="NRC" href="https://adapt-python.github.io/adapt/generated/adapt.parameter_based.NRC.html" coords="648,76,695,97" shape="rect">
+    <area target="" alt="POT" title="POT" href="https://github.com/PythonOT/POT" coords="1467,1007,1517,1030" shape="rect">
+</map>

src_docs/carto.html

@@ -55,7 +55,7 @@ and **target** distributions. The **task** is then learned in this **encoded fea
    :toctree: generated/
    :template: class.rst
 
-   feature_based.FE
+   feature_based.FA
    feature_based.CORAL
    feature_based.SA
    feature_based.fMMD

src_docs/contents.rst

@@ -1,9 +1,9 @@
-:ref:`adapt.feature_based <adapt.feature_based>`.FE
+:ref:`adapt.feature_based <adapt.feature_based>`.FA
 ==========================================================
 
 .. currentmodule:: adapt.feature_based
 
-.. autoclass:: FE
+.. autoclass:: FA
 	:no-members:
 	:no-inherited-members:
 	:no-special-members:
@@ -15,17 +15,17 @@
 
 	.. autosummary::
 
-		~FE.__init__
-		~FE.fit
-		~FE.fit_estimator
-		~FE.fit_transform
-		~FE.get_params
-		~FE.predict
-		~FE.predict_estimator
-		~FE.score
-		~FE.set_params
-		~FE.transform
-		~FE.unsupervised_score
+		~FA.__init__
+		~FA.fit
+		~FA.fit_estimator
+		~FA.fit_transform
+		~FA.get_params
+		~FA.predict
+		~FA.predict_estimator
+		~FA.score
+		~FA.set_params
+		~FA.transform
+		~FA.unsupervised_score
 
 
 	.. automethod:: __init__
@@ -47,5 +47,5 @@
 
    <h2> Examples </h2>
 
-.. include:: ../gallery/FE.rst
+.. include:: ../gallery/FA.rst
 

src_docs/gallery/FA.rst

@@ -0,0 +1,15 @@
+Selecting the right domain adaptation model
+===========================================
+
+When facing a new domain adaptation problem, it can be particularly difficult to choose the appropriate transfer learning algorithm.
+
+The flowchart below has been designed to help the user to quickly identify which type of algorithm
+could be used in a specific case. The choice of transfer method is driven by practical characteristics 
+derived from the available datasets.
+
+Click on any algorithm in the diagram below to see its documentation.
+
+
+.. raw:: html
+    :file: carto.html
+