-
Notifications
You must be signed in to change notification settings - Fork 35
/
mkdocs.yml
139 lines (134 loc) · 3.55 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
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
# Project information
site_name: EasyLLM
site_author: Philipp Schmid
site_url: https://philschmid.github.io/easyllm/
site_description: >-
EasyLLM is an open source project that provides helpful tools and methods for working with large language models (LLMs), both open source and closed source.
# Repository
repo_name: philschmid/easyllm
repo_url: https://github.com/philschmid/easyllm
# Copyright
copyright: Copyright © 2023 Philipp Schmid
# mkdocs.yml
theme:
name: 'material'
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
# - content.code.select
# - content.tabs.link
- content.tooltips
# - header.autohide
- navigation.expand
- navigation.footer
- navigation.indexes
# - navigation.instant
# - navigation.prune
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- navigation.path
- search.highlight
- search.share
- search.suggest
- toc.follow
# - toc.integrate
palette:
- scheme: default
primary: teal
accent: teal
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: teal
accent: teal
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
plugins:
- search
- tags
# - social
- mkdocs-jupyter:
include: ["examples/*.ipynb"] # Default: ["*.py", "*.ipynb"]
- mkdocstrings
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:materialx.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
nav:
- Documentation:
- EasyLLM: index.md
- Installation: installation.md
- "API Reference":
- "Clients":
- clients/index.md
- clients/huggingface.md
- clients/sagemaker.md
- clients/bedrock.md
- prompt_utils.md
- Examples:
- examples/index.md
- "Hugging Face":
- examples/chat-completion-api.ipynb
- examples/stream-chat-completions.ipynb
- examples/text-completion-api.ipynb
- examples/stream-text-completions.ipynb
- examples/get-embeddings.ipynb
- examples/inference-endpoints-example.ipynb
- examples/llama2-rag-example.ipynb
- examples/llama2-agent-example.ipynb
- examples/falcon-180b-chat.ipynb
- "Amazon SageMaker":
- examples/sagemaker-chat-completion-api.ipynb
- examples/sagemaker-text-completion-api.ipynb
- examples/sagemaker-get-embeddings.ipynb
- "Amazon Bedrock":
- examples/bedrock-chat-completion-api.ipynb
- examples/bedrock-stream-chat-completions.ipynb