presidio-research/mkdocs.yml at main · data-privacy-stack/presidio-research · GitHub

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
site_name: Presidio Research
site_url: https://data-privacy-stack.github.io/presidio-research
site_description: Evaluation and data-science tooling for Presidio and PII detection models.
site_author: Data Privacy Stack
copyright: '<a href="https://dataprivacystack.org/">Data Privacy Stack</a>'

repo_url: https://github.com/data-privacy-stack/presidio-research/
edit_uri: ""

# The Home page and the notebook pages are *collected* into the docs tree at
# build time by scripts/zensical_build.py (README.md -> index.md, and the
# notebooks/ tutorials -> notebooks/*.md). They are not committed under docs/;
# the build script stages and converts them before Zensical runs.
nav:
  - Home: index.md
  - Concepts:
      - Evaluation strategies:
        - Home: evaluation.md
        - Token evaluation: token_evaluation.md
        - Span evaluation: span_evaluation.md
        - Span matching strategies: span_matching_strategies.md
      - Entity Mapping:
        - Entity hierarchy: entity_hierarchy.md
        - Why canonical entity mapping: why_canonical_entity_mapping.md
        - Mapping scenarios: mapping_scenarios.md
      - Data generation: data_generation.md
  - Tutorials:
      - Generate data: notebooks/1_Generate_data.ipynb
      - PII dataset EDA: notebooks/2_PII_EDA.ipynb
      - Split by pattern: notebooks/3_Split_by_pattern_number.ipynb
      - Evaluate Presidio Analyzer: notebooks/4_Evaluate_Presidio_Analyzer.ipynb
      - Evaluate a custom Analyzer: notebooks/5_Evaluate_Custom_Presidio_Analyzer.ipynb
      - Interactive entity mapping: notebooks/6_Interactive_Entity_Mapping.ipynb
  - Presidio ↗: https://presidio.dataprivacystack.org

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  logo: assets/dps-icon.svg
  favicon: assets/dps-icon.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.instant.progress
    - content.tabs.link
    - content.code.copy
    - content.code.annotate
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - toc.follow

extra_css:
  - stylesheets/extra.css

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/data-privacy-stack/presidio-research
    - icon: fontawesome/brands/discord
      link: https://discord.gg/MewtBGFquB
    - icon: fontawesome/solid/envelope
      link: mailto:presidio@dataprivacystack.org

markdown_extensions:
  - meta
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.pathconverter
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format