forked from moj-analytical-services/splink
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
113 lines (112 loc) · 4.21 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
site_name: Splink
use_directory_urls: false
repo_url: https://github.com/moj-analytical-services/splink
theme:
name: "material"
features:
- content.code.annotate
- content.tabs.link
- content.tooltips
- header.autohide
- search.highlight
- search.share
- search.suggest
logo: "img/favicon.ico"
favicon: "img/favicon.ico"
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- scheme: slate
primary: purple
accent: red
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
plugins:
- search
- semiliterate
- mknotebooks
- tags
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
show_source: false
custom_templates: templates
markdown_extensions:
- abbr
- attr_list
- meta
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets:
auto_append:
- includes/abbreviations.md
- toc:
permalink: True
nav:
- Home: "README.md"
- Topic Guide:
- Splink's SQL backends - Spark, DuckDB etc: "topic_guides/backends.md"
- Blocking rules for prediction vs estimation: "topic_guides/blocking_rules.md"
- Link type - linkings vs deduping: "topic_guides/link_type.md"
- Defining and customising comparisons: "topic_guides/customising_comparisons.ipynb"
- Run times, performance and linking large data: "topic_guides/drivers_of_performance.md"
- Optimising Spark performance: "topic_guides/optimising_spark.md"
- Salting blocking rules: "topic_guides/salting.md"
- API Reference:
- Linker API:
- Full API: "linker.md"
- Exploratory analysis: "linkerexp.md"
- Estimating model parameters: "linkerest.md"
- Predicting results: "linkerpred.md"
- Visualisation and quality assurance: "linkerqa.md"
- EM Training Session API: "em_training_session.md"
- SplinkDataFrame API: "SplinkDataFrame.md"
- Comparisons API:
- Comparison: "comparison.md"
- Comparison Level: "comparison_level.md"
- Comparisons Library API:
- Comparison Library: "comparison_library.md"
- Comparison Level Library: "comparison_level_library.md"
- Settings Editor: "settingseditor/editor.md"
- Settings dictionary reference: "settings_dict_guide.md"
- Tutorials:
- 0. Tutorial introduction: "demos/00_Tutorial_Introduction.ipynb"
- 1. Exploratory analysis: "demos/01_Exploratory_analysis.ipynb"
- 2. Blocking: "demos/02_Blocking.ipynb"
- 3. Estimating model parameters: "demos/03_Estimating_model_parameters.ipynb"
- 4. Predicting results: "demos/04_Predicting_results.ipynb"
- 5. Visualising predictions: "demos/05_Visualising_predictions.ipynb"
- 6. Quality assurance: "demos/06_Quality_assurance.ipynb"
- Examples:
- Examples index: "examples_index.md"
- DuckDB:
- Deduplicate 50k rows historial persons: "demos/example_deduplicate_50k_synthetic.ipynb"
- Linking financial transactions: "demos/example_transactions.ipynb"
- Linking two tables of persons: "demos/example_link_only.ipynb"
- Real time record linkage: "demos/example_real_time_record_linkage.ipynb"
- QA from ground truth column: "demos/example_accuracy_analysis_from_labels_column.ipynb"
- Quick and dirty persons model: "demos/example_quick_and_dirty_persons.ipynb"
- Febrl3 Dedupe: "demos/example_febrl3.ipynb"
- Febrl4 link-only: "demos/example_febrl4.ipynb"
- PySpark:
- Deduplication using Pyspark: "demos/example_simple_pyspark.ipynb"
- Developers' guides:
- Caching and pipelining: "dev_guides/caching.md"
- Understanding and debugging Splink: "dev_guides/debug_modes.md"
- Spark caching: "dev_guides/spark_pipelining_and_caching.md"
- Transpilation using sqlglot: "dev_guides/transpilation.md"
- Building docs: "dev_guides/build_docs_locally.md"
extra_css:
- css/custom.css