Skip to content

Commit

Permalink
Merge pull request #949 from NickCrews/docs-datetime
Browse files Browse the repository at this point in the history
Tweak docs a bit more
  • Loading branch information
fgregg committed Feb 2, 2022
2 parents 92869d1 + 29a0e2b commit a800831
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 11 deletions.
5 changes: 4 additions & 1 deletion dedupe/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1083,7 +1083,10 @@ def train(self,
index_predicates: Should dedupe consider predicates
that rely upon indexing the
data. Index predicates can be slower
and take substantial memory.
and take substantial memory. Without
index predicates, you may get lower
recall when true-dupes are not blocked
together.
"""
assert self.active_learner is not None, \
Expand Down
25 changes: 15 additions & 10 deletions docs/Variable-definition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,15 @@ prices. The values of ``Price`` field must be a positive float. If the value is
{'field': 'cost', 'type': 'Price'}
Optional Variables
------------------

These variables aren't included in the core of dedupe, but are available to
install separately if you want to use them.

In addition to the several variables below, you can find `more optional
variables on GitHub <https://github.com/search?q=org%3Adedupeio+dedupe-variable>`__.

DateTime
^^^^^^^^

Expand Down Expand Up @@ -303,9 +312,10 @@ and :code:`type`:
{'field': 'time_of_sale', 'type': 'DateTime'}
Optional Variables
------------------
Install the `dedupe-variable-datetime
<https://pypi.python.org/pypi/dedupe-variable-datetime>`__ package for
``DateTime`` Type. For more info, see the `GitHub Repository
<https://github.com/dedupeio/dedupe-variable-datetime>`__.

Address Type
^^^^^^^^^^^^
Expand Down Expand Up @@ -379,16 +389,11 @@ the ``FuzzyCategorical`` Type. For more info, see the `GitHub Repository
<https://github.com/dedupeio/fuzzycategory>`__.


Other Optional Variables
^^^^^^^^^^^^^^^^^^^^^^^^

In addition to the several optional variables above, you can find `more optional
variables on GitHub <https://github.com/search?q=org%3Adedupeio+dedupe-variable>`__.

Missing Data
------------
If the value of field is missing, that missing value should be represented as
a ``None`` object.
a ``None`` object. You should also use ``None`` to represent empty strings
(eg ``''``).

.. code:: python
Expand Down

0 comments on commit a800831

Please sign in to comment.