PiNN/mkdocs.yml at master · Teoroo-CMC/PiNN · 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
site_name: <span>Pi</span>NN
repo_name: teoroo-cmc/pinn
repo_url: https://github.com/teoroo-cmc/pinn/
site_url: https://teoroo-cmc.github.io/pinn/
nav:
  - Home:
      - Introduction: index.md
      - Changelog: changelog.md
      - Migration: migration.md
      - Benchmarks: benchmarks.md
      - Contribute: contribute.md
  - Usage:
      - Overview: usage/overview.md
      - Quick Start: usage/quick_start.md
      - IO:
          - Datasets: usage/datasets.md
      - Networks:
          - Overview: usage/networks.md
          - Layers: usage/layers.md
          - PiNet: usage/pinet.md
          - PiNet2: usage/pinet2.md
          - BPNN: usage/bpnn.md
      - Models:
          - Overview: usage/models.md
          - Potential: usage/potential.md
          - Dipole: usage/dipole.md
          - Polarizability: usage/polarizability.md
          - Customize: usage/custom_model.md
      - CLI:
          - convert: usage/cli/convert.md
          - train: usage/cli/train.md
          - log: usage/cli/log.md
          - report: usage/cli/report.md
      - Misc:
          - Optimizers: usage/optimizers.md
          - Visualize: usage/visualize.md
  - Notebooks:
      - Overview: notebooks/overview.md
      - Tutorials:
          - Quick Start: notebooks/Quick_tour.ipynb
          - Training Tips: notebooks/More_on_training.ipynb
      - Examples:
          - Custom Data: notebooks/Customizing_dataset.ipynb
          - LJ Potential: notebooks/Learn_LJ_potential.ipynb
          - ML Potential: notebooks/Build_MLP_Water.ipynb
      - Develop:
          - Layer Debug: notebooks/Layer_debug.ipynb
watch:
  - pinn
plugins:
  - bibtex:
      bib_file: "docs/references.bib"
      csl_file: "docs/jcp.csl"
  - mknotebooks
  - mkdocstrings:
      custom_templates: docs/templates
      handlers:
        python:
          rendering:
            show_source: false
            show_root_toc_entry: false
            heading_level: 4
  - mike
theme:
  name: flux
extra:
  version:
    provider: mike
markdown_extensions:
  - toc:
      toc_depth: 3
  - admonition
  - attr_list
  - footnotes
  - pymdownx.snippets
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true
extra_javascript:
  - js/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@4.0.0-beta.3/tex-chtml-nofont.js
extra_css:
  - css/extra.css