Skip to content

Fix documentation build errors. #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 12, 2022
Merged

Fix documentation build errors. #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cce845d
Fix errors due to rst reference via |.
kklein Aug 11, 2022
2ae93af
Fix warning by adapting length of underline.
kklein Aug 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Getting Started
============
===============


Glossary
Expand Down
26 changes: 15 additions & 11 deletions src/datajudge/requirements.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1216,10 +1216,11 @@ def add_row_equality_constraint(
condition1: Condition = None,
condition2: Condition = None,
):
"""At most max_missing_fraction of rows in T1 and T2 are absent in either.
"""At most ``max_missing_fraction`` of rows in T1 and T2 are absent in either.

I.e. (|T1 - T2| + |T2 - T1|) / |T1 U T2| <= max_missing_fraction.
Rows from T1 are indexed in columns1, rows from T2 are indexed in columns2.
In other words,
:math:`\\frac{|T1 - T2| + |T2 - T1|}{|T1 \\cup T2|} \\leq` ``max_missing_fraction``.
Rows from T1 are indexed in ``columns1``, rows from T2 are indexed in ``columns2``.
"""
ref = DataReference(self.data_source, columns1, condition1)
ref2 = DataReference(self.data_source2, columns2, condition2)
Expand All @@ -1236,13 +1237,14 @@ def add_row_subset_constraint(
condition1: Condition = None,
condition2: Condition = None,
):
"""At most max_missing_fraction of rows in T1 are not in T2.
"""At most ``max_missing_fraction`` of rows in T1 are not in T2.

I.e. |T1-T2|/|T1| <= max_missing_fraction.
Rows from T1 are indexed in columns1, rows from T2 are indexed in columns2.
In other words,
:math:`\\frac{|T1-T2|}{|T1|} \\leq` ``max_missing_fraction``.
Rows from T1 are indexed in columns1, rows from T2 are indexed in ``columns2``.

In particular, the operation |T1-T2| relies on a sql EXCEPT statement. In
constrast to EXCEPT ALL, this should lead to a set subtraction instead of
In particular, the operation ``|T1-T2|`` relies on a sql ``EXCEPT`` statement. In
constrast to ``EXCEPT ALL``, this should lead to a set subtraction instead of
a multiset subtraction. In other words, duplicates in T1 are treated as
single occurrences.
"""
Expand All @@ -1264,10 +1266,12 @@ def add_row_superset_constraint(
condition1: Condition = None,
condition2: Condition = None,
):
"""At most max_missing_fraction of rows in T2 are not in T1.
"""At most ``max_missing_fraction`` of rows in T2 are not in T1.

I.e. |T2-T1|/|T2| <= max_missing_fraction.
Rows from T1 are indexed in columns1, rows from T2 are indexed in columns2.
In other words,
:math:`\\frac{|T2-T1|}{|T2|} \\leq` ``max_missing_fraction``.
Rows from T1 are indexed in ``columns1``, rows from T2 are indexed in
``columns2``.
"""
max_missing_fraction_getter = self.get_deviation_getter(
constant_max_missing_fraction, date_range_loss_fraction
Expand Down