tcbench/mkdocs.yml at main · tcbenchstack/tcbench · 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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
site_name: ""
docs_dir: docs.material

theme:
  name: material
  features:
    - content.code.copy
    #- navigation.expand
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.footer
    - navigation.indexes
  custom_dir: docs.material/overrides
  logo: overrides/tcbench_logo.svg


nav:
    - About: about.md
    - tcbench:
        - tcbench/install.md
        - tcbench/cli_intro.md
        - tcbench/internals.md
#        - API:
#            - cli:
#                - tcbench/api/tcbench_cli_clickutils.md
#                - tcbench/api/tcbench_cli_command_aimrepo.md
#                - tcbench/api/tcbench_cli_command_campaign.md
#                - tcbench/api/tcbench_cli_command_datasets.md
#                - tcbench/api/tcbench_cli_command_singlerun.md
#                - tcbench/api/tcbench_cli_richutils.md
#            - libtcdatasets:
#                - tcbench/api/tcbench_libtcdatasets_datasets_utils.md
#                - tcbench/api/tcbench_libtcdatasets_ucdavis_icdm19_csv_to_parquet.md
#                - tcbench/api/tcbench_libtcdatasets_tcbench_ucdavis_icdm19_generate_splits.md
#                - tcbench/api/tcbench_libtcdatasets_mirage19_json_to_parquet.md
#                - tcbench/api/tcbench_libtcdatasets_mirage19_generate_splits.md
#                - tcbench/api/tcbench_libtcdatasets_mirage22_json_to_parquet.md
#                - tcbench/api/tcbench_libtcdatasets_tcbench_mirage22_generate_splits.md
#                - tcbench/api/tcbench_libtcdatasets_utmobilenet21_csv_to_parquet.md
#                - tcbench/api/tcbench_libtcdatasets_tcbench_utmobilenet21_generate_splits.md
#            - modeling:
#                - tcbench/api/tcbench_modeling_augmentation.md
#                - tcbench/api/tcbench_modeling_aimutils.md
#                - tcbench/api/tcbench_modeling_backbone.md
#                - tcbench/api/tcbench_modeling_dataprep.md
#                - tcbench/api/tcbench_modeling_losses.md
#                - tcbench/api/tcbench_modeling_methods.md
#                - tcbench/api/tcbench_modeling_utils.md
#                - tcbench/api/tcbench_modeling_run_augmentations_at_loading.md
#                - tcbench/api/tcbench_modeling_run_augmentations_at_loading_xgboost.md
#                - tcbench/api/tcbench_modeling_run_contrastive_learning_and_finetune.md
#                - tcbench/api/tcbench_modeling_run_campaign_augmentations_at_loading.md
#                - tcbench/api/tcbench_modeling_run_campaign_augmentations_at_loading_xgboost.md
#                - tcbench/api/tcbench_modeling_run_campaign_contrastive_learning_and_finetune.md
    - Datasets:
        - datasets/index.md
        - datasets/curation_and_metadata.md
        - Install:
            - datasets/install/index.md
            - datasets/install/ucdavis-icdm19.md
            - datasets/install/mirage19.md
            - datasets/install/mirage22.md
            - datasets/install/utmobilenet21.md
        - datasets/import.md
        - Schemas:
            - datasets/schemas/index.md
            - datasets/schemas/ucdavis-icdm19.md
            - datasets/schemas/mirage19.md
            - datasets/schemas/mirage22.md
            - datasets/schemas/utmobilenet21.md
        - Samples count:
            - datasets/samples_count/index.md
            - datasets/samples_count/ucdavis-icdm19.md
            - datasets/samples_count/mirage19.md
            - datasets/samples_count/mirage22.md
            - datasets/samples_count/utmobilenet21.md
        - Guides:
            - datasets/guides/index.md
            - datasets/guides/tutorial_load_datasets.md
    - Modeling:
        - modeling/index.md
        - modeling/runs.md
        - modeling/campaigns.md
        - ML Repos:
            - modeling/aim_repos/index.md
            - modeling/aim_repos/aimrepo_subcmd.md
            - modeling/aim_repos/aim_webui.md
    - Papers:
        - papers/index.md
        - IMC23:
            - papers/imc23/index.md
            - papers/imc23/artifacts.md
            - papers/imc23/notebooks.md
            - papers/imc23/ml_artifacts.md
            - papers/imc23/pytest.md


copyright: Copyright tcbenchstack 2023

extra_css:
- css/style.css
- css/material.css
- css/mkdocstrings.css
- css/fonts.css
- css/tables_style.css
- css/jupyter-notebook.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          setup_commands:
            - import sys
            - sys.path.append("docs")
          options:
            filters: []
            new_path_syntax: yes
            show_source: true
            show_signature_annotations: false
            members_order: source
            show_root_heading: false
            heading_level: 3
  - table-reader
  - glightbox
#  - mkdocs-jupyter:
#      execute: false
#      include_source: True

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - tables
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.tabbed:
        alternate_style: true
  - toc:
      permalink: true