Skip to content

Commit 5bf6d7b

Browse files
antoinedemathelinantoinedemathelin
committed
Add test and docs metrics
1 parent 1efbd7b commit 5bf6d7b

13 files changed

+468
-100
lines changed

‎adapt/metrics.py

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

‎src_docs/_templates/layout.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,17 @@
4444
<li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.parameter_based.RegularTransferNN") }}">RegularTransferNN</a></li>
4545
</ul>
4646
</li>
47+
<li class="toctree-l1"><a class="reference internal" href="{{ pathto("contents") }}{{ contents }}{{ "adapt-metrics" }}">Metrics</a><ul>
48+
<li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.metrics.cov_distance") }}">cov_distance</a></li>
49+
<li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.metrics.j_score") }}">j_score</a></li>
50+
<li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.metrics.linear_discrepancy") }}">linear_discrepancy</a></li>
51+
<li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.metrics.normalized_linear_discrepancy") }}">normalized_linear_discrepancy</a></li>
52+
<li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.metrics.frechet_distance") }}">frechet_distance</a></li>
53+
<li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.metrics.normalized_frechet_distance") }}">normalized_frechet_distance</a></li>
54+
<li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.metrics.domain_classifier") }}">domain_classifier</a></li>
55+
<li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.metrics.reverse_validation") }}">reverse_validation</a></li>
56+
</ul>
57+
</li>
4758
<li class="toctree-l1"><a class="reference internal" href="{{ pathto("contents") }}{{ contents }}{{ "adapt-utils" }}">Utility Functions</a><ul>
4859
<li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.utils.accuracy") }}">accuracy</a></li>
4960
<li class="toctree-l2"><a class="reference internal" href="{{ pathto("generated/adapt.utils.check_arrays") }}">check_arrays</a></li>

‎src_docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ def linkcode_resolve(domain, info):
120120

121121
object_name = "_" + object_name
122122

123-
if "utils" in info['module']:
123+
if "utils" in info['module'] or "metrics" in info['module']:
124124
filename = info['module'].replace('.', '/')
125125
else:
126126
filename = os.path.join(info['module'].replace('.', '/'), object_name)

‎src_docs/contents.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,34 @@ the **source** data are adapted to build a suited model for the **task** on the
133133
parameter_based.RegularTransferLC
134134
parameter_based.RegularTransferNN
135135

136+
137+
.. _adapt.metrics:
138+
139+
:ref:`adapt.metrics <adapt.metrics>`: Metrics
140+
---------------------------------------------------
141+
142+
This module contains functions to compute adaptation metrics.
143+
144+
.. automodule: adapt.metrics
145+
:no-members:
146+
:no-inherited-members:
147+
148+
.. currentmodule:: adapt
149+
150+
.. autosummary::
151+
:toctree: generated/
152+
:template: function.rst
153+
154+
metrics.cov_distance
155+
metrics.j_score
156+
metrics.linear_discrepancy
157+
metrics.normalized_linear_discrepancy
158+
metrics.frechet_distance
159+
metrics.normalized_frechet_distance
160+
metrics.domain_classifier
161+
metrics.reverse_validation
162+
163+
136164
.. _adapt.utils:
137165

138166
:ref:`adapt.utils <adapt.utils>`: Utility Functions

‎src_docs/generated/adapt.metrics.cov_distance.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
:ref:`adapt.metrics <adapt.metrics>`.cov_distance
2+
==============================================================
3+
4+
.. currentmodule:: adapt.metrics
5+
6+
.. autofunction:: cov_distance
7+
8+

‎src_docs/generated/adapt.metrics.domain_classifier.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
:ref:`adapt.metrics <adapt.metrics>`.domain_classifier
2+
===================================================================
3+
4+
.. currentmodule:: adapt.metrics
5+
6+
.. autofunction:: domain_classifier
7+
8+

‎src_docs/generated/adapt.metrics.frechet_distance.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
:ref:`adapt.metrics <adapt.metrics>`.frechet_distance
2+
==================================================================
3+
4+
.. currentmodule:: adapt.metrics
5+
6+
.. autofunction:: frechet_distance
7+
8+

‎src_docs/generated/adapt.metrics.j_score.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
:ref:`adapt.metrics <adapt.metrics>`.j_score
2+
=========================================================
3+
4+
.. currentmodule:: adapt.metrics
5+
6+
.. autofunction:: j_score
7+
8+

‎src_docs/generated/adapt.metrics.linear_discrepancy.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
:ref:`adapt.metrics <adapt.metrics>`.linear_discrepancy
2+
====================================================================
3+
4+
.. currentmodule:: adapt.metrics
5+
6+
.. autofunction:: linear_discrepancy
7+
8+

‎src_docs/generated/adapt.metrics.normalized_frechet_distance.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
:ref:`adapt.metrics <adapt.metrics>`.normalized_frechet_distance
2+
=============================================================================
3+
4+
.. currentmodule:: adapt.metrics
5+
6+
.. autofunction:: normalized_frechet_distance
7+
8+

0 commit comments

Comments
 (0)