Skip to content

Commit 07ad22b

Browse files
riley-harperriley-harper
authored
Merge pull request #203 from ipums/v4.1.0
Updated the project version in pyproject.toml to 4.1.0
2 parents b4e249a + 906ea1a commit 07ad22b

27 files changed

+65
-57
lines changed

‎docs/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 48fcabef437f66d0a6b21e5ecef30415
3+
config: 8ce903234e24ddc795ce585a1fcc3856
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_sources/changelog.md.txt‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The format of this changelog is based on [Keep A Changelog][keep-a-changelog].
44
Hlink adheres to semantic versioning as much as possible.
55

6-
## Not Yet Released
6+
## v4.1.0 (2025-04-15)
77

88
### Added
99

@@ -12,6 +12,10 @@ Hlink adheres to semantic versioning as much as possible.
1212
find the documentation for this option in the new [Household Matching][household-matching-docs]
1313
section on the Configuration page. [PR #201][pr201]
1414

15+
* Added the `hh_training.feature_importances` configuration option for saving model
16+
feature importances or coefficients as step 3 of
17+
["Household Training"][household-training-docs] when set to true. [PR #202][pr202]
18+
1519
### Fixed
1620

1721
* Fixed a bug in the calculation of predicted matches. Previously, if there was
@@ -389,8 +393,10 @@ and false negative data in model exploration. [PR #1][pr1]
389393
[pr189]: https://github.com/ipums/hlink/pull/189
390394
[pr200]: https://github.com/ipums/hlink/pull/200
391395
[pr201]: https://github.com/ipums/hlink/pull/201
396+
[pr202]: https://github.com/ipums/hlink/pull/202
392397

393398
[household-matching-docs]: config.html#household-matching
399+
[household-training-docs]: config.html#household-training-and-model-exploration
394400
[ints-to-longs-docs]: config.html#data-sources
395401
[link-tasks-docs]: link_tasks
396402
[pyspark-interaction-docs]: https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.ml.feature.Interaction.html

‎docs/_sources/link_tasks.md.txt‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,9 @@ The first three steps in each of these tasks are the same:
3939
* Step 0: Ingest the training data from a CSV file.
4040
* Step 1: Create comparison features.
4141
* Step 2: Train and save the model.
42-
43-
The last step is available only for Training, not for Household Training.
4442
* Step 3: Save the coefficients or feature importances of the model for inspection.
4543
This step is skipped by default. To enable it, set the `training.feature_importances`
46-
config attribute to true in your config file.
44+
and/or the `hh_training.feature_importances` config attribute(s) to true in your config file.
4745

4846
### Related Configuration Sections
4947

‎docs/_static/documentation_options.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '4.0.0',
2+
VERSION: '4.1.0',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

‎docs/changelog.html‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

8-
<title>Changelog &#8212; hlink 4.0.0 documentation</title>
8+
<title>Changelog &#8212; hlink 4.1.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
1010
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
1111
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
12-
<script src="_static/documentation_options.js?v=3304f9e4"></script>
12+
<script src="_static/documentation_options.js?v=42d1b3bd"></script>
1313
<script src="_static/doctools.js?v=9bcbadda"></script>
1414
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1515
<link rel="index" title="Index" href="genindex.html" />
@@ -37,15 +37,18 @@
3737
<h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading"></a></h1>
3838
<p>The format of this changelog is based on <a class="reference external" href="https://keepachangelog.com/en/1.0.0/">Keep A Changelog</a>.
3939
Hlink adheres to semantic versioning as much as possible.</p>
40-
<section id="not-yet-released">
41-
<h2>Not Yet Released<a class="headerlink" href="#not-yet-released" title="Link to this heading"></a></h2>
40+
<section id="v4-1-0-2025-04-15">
41+
<h2>v4.1.0 (2025-04-15)<a class="headerlink" href="#v4-1-0-2025-04-15" title="Link to this heading"></a></h2>
4242
<section id="added">
4343
<h3>Added<a class="headerlink" href="#added" title="Link to this heading"></a></h3>
4444
<ul class="simple">
4545
<li><p>Added a new configuration option <code class="docutils literal notranslate"><span class="pre">hh_matching.records_to_match</span></code> that controls
4646
which records are eligible for re-matching in the <code class="docutils literal notranslate"><span class="pre">hh_matching</span></code> task. You can
4747
find the documentation for this option in the new <a class="reference external" href="config.html#household-matching">Household Matching</a>
4848
section on the Configuration page. <a class="reference external" href="https://github.com/ipums/hlink/pull/201">PR #201</a></p></li>
49+
<li><p>Added the <code class="docutils literal notranslate"><span class="pre">hh_training.feature_importances</span></code> configuration option for saving model
50+
feature importances or coefficients as step 3 of
51+
<a class="reference external" href="config.html#household-training-and-model-exploration">“Household Training”</a> when set to true. <a class="reference external" href="https://github.com/ipums/hlink/pull/202">PR #202</a></p></li>
4952
</ul>
5053
</section>
5154
<section id="fixed">
@@ -507,7 +510,7 @@ <h1 class="logo"><a href="index.html">hlink</a></h1>
507510
<li class="toctree-l1"><a class="reference internal" href="use_examples.html">Advanced Workflows</a></li>
508511
<li class="toctree-l1"><a class="reference internal" href="config.html">Configuration</a></li>
509512
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
510-
<li class="toctree-l2"><a class="reference internal" href="#not-yet-released">Not Yet Released</a></li>
513+
<li class="toctree-l2"><a class="reference internal" href="#v4-1-0-2025-04-15">v4.1.0 (2025-04-15)</a></li>
511514
<li class="toctree-l2"><a class="reference internal" href="#v4-0-0-2025-04-07">v4.0.0 (2025-04-07)</a></li>
512515
<li class="toctree-l2"><a class="reference internal" href="#v3-8-0-2024-12-04">v3.8.0 (2024-12-04)</a></li>
513516
<li class="toctree-l2"><a class="reference internal" href="#v3-7-0-2024-10-10">v3.7.0 (2024-10-10)</a></li>

‎docs/column_mappings.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

8-
<title>Column Mappings &#8212; hlink 4.0.0 documentation</title>
8+
<title>Column Mappings &#8212; hlink 4.1.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
1010
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
1111
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
12-
<script src="_static/documentation_options.js?v=3304f9e4"></script>
12+
<script src="_static/documentation_options.js?v=42d1b3bd"></script>
1313
<script src="_static/doctools.js?v=9bcbadda"></script>
1414
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1515
<link rel="index" title="Index" href="genindex.html" />

‎docs/comparison_features.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

8-
<title>Comparison Features &#8212; hlink 4.0.0 documentation</title>
8+
<title>Comparison Features &#8212; hlink 4.1.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
1010
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
1111
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
12-
<script src="_static/documentation_options.js?v=3304f9e4"></script>
12+
<script src="_static/documentation_options.js?v=42d1b3bd"></script>
1313
<script src="_static/doctools.js?v=9bcbadda"></script>
1414
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1515
<link rel="index" title="Index" href="genindex.html" />

‎docs/comparisons.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

8-
<title>Comparisons &#8212; hlink 4.0.0 documentation</title>
8+
<title>Comparisons &#8212; hlink 4.1.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
1010
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
1111
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
12-
<script src="_static/documentation_options.js?v=3304f9e4"></script>
12+
<script src="_static/documentation_options.js?v=42d1b3bd"></script>
1313
<script src="_static/doctools.js?v=9bcbadda"></script>
1414
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1515
<link rel="index" title="Index" href="genindex.html" />

‎docs/config.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

8-
<title>Configuration &#8212; hlink 4.0.0 documentation</title>
8+
<title>Configuration &#8212; hlink 4.1.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
1010
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
1111
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
12-
<script src="_static/documentation_options.js?v=3304f9e4"></script>
12+
<script src="_static/documentation_options.js?v=42d1b3bd"></script>
1313
<script src="_static/doctools.js?v=9bcbadda"></script>
1414
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1515
<link rel="index" title="Index" href="genindex.html" />

‎docs/feature_selection_transforms.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

8-
<title>Feature Selection Transforms &#8212; hlink 4.0.0 documentation</title>
8+
<title>Feature Selection Transforms &#8212; hlink 4.1.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
1010
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
1111
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
12-
<script src="_static/documentation_options.js?v=3304f9e4"></script>
12+
<script src="_static/documentation_options.js?v=42d1b3bd"></script>
1313
<script src="_static/doctools.js?v=9bcbadda"></script>
1414
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1515
<link rel="index" title="Index" href="genindex.html" />

0 commit comments

Comments
 (0)