Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
188 lines (182 loc) · 5.46 KB
/
Copy pathmkdocs.yml
File metadata and controls
188 lines (182 loc) · 5.46 KB
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
# Project information
site_name: dstack
site_url: https://dstack.ai
site_author: dstack GmbH
site_description: >-
dstack simplifies training, fine-tuning, and deploying generative AI models, leveraging the open-source ecosystem.
# Repository
repo_url: https://github.com/dstackai/dstack
repo_name: dstackai/dstack
edit_uri: edit/master/docs/
#Copyright
copyright: © 2023 dstack
# Configuration
theme:
name: material
custom_dir: docs/overrides
logo: assets/images/dstack-logo-notext.svg
favicon: assets/images/dstack-fav-32.ico
icon:
repo: custom/github
edit: material/pencil
annotation: material/arrow-right-circle
font:
text: Source Sans Pro
code: IBM Plex Mono
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
accent: lilac
# toggle:
# icon: material/weather-night
# name: Switch to dark mode
# - media: "(prefers-color-scheme: dark)"
# scheme: slate
# primary: black
# accent: light blue
# toggle:
# icon: material/weather-sunny
# name: Switch to light mode
features:
# - navigation.path
- content.code.copy
- content.action.edit
# - navigation.indexes
- navigation.tabs
# - navigation.instant
# - toc.integrate
- navigation.sections
# - navigation.expand
- navigation.top
- announce.dismiss
- navigation.tracking
- navigation.footer
# Plugins
plugins:
- blog:
blog_dir: blog
blog_toc: true
- social:
cards_layout_options:
background_color: "black"
color: "#FFFFFF"
font_family: Roboto
# debug: true
cards_layout_dir: layouts
cards_layout: custom
- search
- redirects:
redirect_maps:
'quickstart.md': 'docs/index.md'
'docs/quick-start.md': 'docs/index.md'
'docs/installation/index.md': 'docs/index.md'
'tutorials/stable-diffusion.md': 'examples/stable-diffusion-xl.md'
'docs/guides/projects.md': 'docs/configuration/server.md'
'examples/python-api.md': 'examples/deploy-python.md'
'guides/clouds.md': 'configuration/server.md'
- typeset
- gen-files:
scripts: # always relative to mkdocs.yml
- scripts/docs/gen_cli_reference.py
- scripts/docs/gen_schema_reference.py
- mkdocstrings:
handlers:
python:
options:
docstring_style: google
show_source: false
# Extensions
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- attr_list
- def_list
- admonition
- pymdownx.highlight
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- toc:
toc_depth: 3
permalink: true
- attr_list
- md_in_html
- footnotes
- tables
# Customization
extra_css:
- assets/stylesheets/extra.css
- assets/stylesheets/termynal.css
- assets/stylesheets/landing.css
extra_javascript:
- assets/javascripts/extra.js
extra:
homepage: /
generator: false
analytics:
provider: google
property: G-JX21114P7B
social:
- icon: /fontawesome/brands/github
link: https://github.com/dstackai/dstack
# - icon: /fontawesome/brands/python
# link: https://pypi.org/project/dstack
- icon: /fontawesome/brands/docker
link: https://hub.docker.com/r/dstackai/dstack
- icon: /fontawesome/brands/discord
link: https://discord.gg/u8SmfwPpMd
- icon: /simple/x
link: https://twitter.com/dstackai
status:
new: Recently added
# Page tree
nav:
- Home: index.md
- Docs:
- Getting started:
- Quickstart: docs/index.md
# - Installation:
# - pip: docs/installation/pip.md
# - Docker: docs/installation/docker.md
- Configuration:
- Server configuration: docs/configuration/server.md
- Guides:
- Fine-tuning: docs/guides/fine-tuning.md
- Dev environments: docs/guides/dev-environments.md
- Tasks: docs/guides/tasks.md
- Services: docs/guides/services.md
- Reference:
- CLI: docs/reference/cli/index.md
- API: docs/reference/api/python/index.md
- .dstack.yml:
- dev-environment: docs/reference/dstack.yml/dev-environment.md
- task: docs/reference/dstack.yml/task.md
- service: docs/reference/dstack.yml/service.md
- "server/config.yml": docs/reference/server/config.yml.md
- profiles.yml: docs/reference/profiles.yml.md
- Examples:
- examples/index.md
- Examples:
- RAG with Llama Index and Weaviate: examples/llama-index-weaviate.md
- Deploying LLMs using Python API: examples/deploy-python.md
- Fine-tuning Llama 2 using QLoRA: examples/finetuning-llama-2.md
- Deploying LLMs using TGI: examples/text-generation-inference.md
- Deploying SDXL using FastAPI: examples/stable-diffusion-xl.md
- Deploying LLMs using vLLM: examples/vllm.md
- Blog:
- blog/index.md
- Discord: https://discord.gg/u8SmfwPpMd
- Twitter: https://twitter.com/dstackai/