Files

 66d76e5

/

mkdocs.yml

Blame

Blame

Latest commit

 

History

History

162 lines (151 loc) · 4.64 KB

 66d76e5

/

mkdocs.yml

Top

File metadata and controls

• Code
• Blame

162 lines (151 loc) · 4.64 KB

Raw

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

151

152

153

154

155

156

157

158

159

160

161

# Project information

site_name: TRecover

site_description: A Python library to train Transformer neural network for keyless reading task.

site_author: Alexander Shulga

# Repository

repo_url: https://github.com/alex-snd/TRecover

repo_name: alex-snd/TRecover

edit_uri: "" # disables edit button

# Copyright

copyright: Copyright © 2022

# Social media

extra:

social:

- icon: fontawesome/brands/linkedin

link: https://www.linkedin.com/in/alex-snd

- icon: fontawesome/brands/telegram

link: https://t.me/alexsnd

- icon: fontawesome/solid/at

link: mailto:[email protected]

- icon: fontawesome/brands/github

link: https://github.com/alex-snd

- icon: fontawesome/brands/docker

link: https://hub.docker.com/u/alexsnd0

analytics:

provider: google

property: G-1NKZB5WK07

consent:

title: Cookie consent

description: >-

We use cookies to recognize your repeated visits and preferences, as well

as to measure the effectiveness of our documentation and whether users

find what they're searching for. With your consent, you're helping us to

make our documentation better.

actions:

- accept

- reject

# Configuration

theme:

name: material

logo: static/images/logo.png

favicon: static/images/favicon.ico

font:

text: Georgia

code: Roboto Mono

features:

- navigation.tabs

- navigation.expand

- navigation.indexes

- toc.follow

- navigation.instant

- navigation.tracking

- content.tabs.link

- navigation.top

icon:

repo: fontawesome/brands/github

# Extra CSS

extra_css:

- static/css/custom.css

- static/css/termynal.css

# Extra Js

extra_javascript:

- https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js

- https://polyfill.io/v3/polyfill.min.js?features=es6

- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

- static/js/termynal.js

- static/js/custom.js

# Extensions

markdown_extensions:

- meta

- abbr

- md_in_html

- pymdownx.emoji:

emoji_index: !!python/name:materialx.emoji.twemoji

emoji_generator: !!python/name:materialx.emoji.to_svg

- admonition # alerts

- pymdownx.details # collapsible alerts

- pymdownx.superfences # nest code and content inside alerts

- attr_list # add HTML and CSS to Markdown elements

- pymdownx.inlinehilite # inline code highlights

- pymdownx.keys # show keystroke symbols

- pymdownx.snippets # insert content from other files

- pymdownx.tabbed: # content tabs

alternate_style: true

- footnotes

- def_list

- pymdownx.arithmatex: # mathjax

generic: true

- pymdownx.tasklist:

custom_checkbox: true

clickable_checkbox: true

- codehilite

- pymdownx.highlight:

use_pygments: true

anchor_linenums: true

- toc:

toc_depth: 4

# Plugins

plugins:

- search

- macros

- mkdocstrings:

default_handler: python

handlers:

python:

selection:

docstring_style: numpy

rendering:

show_root_heading: false

show_root_toc_entry: false

show_root_full_path: false

show_source: true

show_category_heading: false

separate_signature: true

members_order: source

watch:

- src/trecover

# Page tree

nav:

- Home: index.md

- Getting started:

- Installation: getting_started/installation.md

- Data: getting_started/data.md

- Train: getting_started/train.md

- Objective:

- Task definition: objective/task_definition.md

- Summary: objective/summary.md

- Demo: demo.md

- Reference:

- CLI:

- src/trecover/app/cli/index.md

- Download: src/trecover/app/cli/download.md

- Collab: src/trecover/app/cli/collab.md

- Mlflow: src/trecover/app/cli/mlflow.md

- Dashboard: src/trecover/app/cli/dashboard.md

- API: src/trecover/app/cli/api.md

- Worker: src/trecover/app/cli/worker.md

- Broker: src/trecover/app/cli/broker.md

- Backend: src/trecover/app/cli/backend.md

- API:

- src/trecover/app/api/index.md

- Schemas: src/trecover/app/api/schemas.md

- Celery Tasks: src/trecover/app/api/backend/tasks.md

- Utils:

- Beam Search: src/trecover/utils/beam_search.md

- CLI: src/trecover/utils/cli.md

- Docker: src/trecover/utils/docker.md

- Inference: src/trecover/utils/inference.md

- Model: src/trecover/utils/model.md

- Train: src/trecover/utils/train.md

- Transform: src/trecover/utils/transform.md

- Visualization: src/trecover/utils/visualization.md