Skip to content

Commit d313040

Browse files
smokestacklightninsmokestacklightnin
committed
Get basic documentation up and running
1 parent d89b272 commit d313040

File tree

6 files changed

+169
-0
lines changed

6 files changed

+169
-0
lines changed

‎mkdocs.yml

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
site_name: "Serving"
2+
repo_name: "Serving Models"
3+
repo_url: https://github.com/tensorflow/serving
4+
5+
docs_dir: tensorflow_serving/g3doc
6+
7+
theme:
8+
name: material
9+
palette:
10+
# Palette toggle for automatic mode
11+
- media: "(prefers-color-scheme)"
12+
primary: custom
13+
accent: custom
14+
toggle:
15+
icon: material/brightness-auto
16+
name: Switch to light mode
17+
18+
# Palette toggle for light mode
19+
- media: "(prefers-color-scheme: light)"
20+
primary: custom
21+
accent: custom
22+
scheme: default
23+
toggle:
24+
icon: material/brightness-7
25+
name: Switch to dark mode
26+
27+
# Palette toggle for dark mode
28+
- media: "(prefers-color-scheme: dark)"
29+
primary: custom
30+
accent: custom
31+
scheme: slate
32+
toggle:
33+
icon: material/brightness-4
34+
name: Switch to system preference
35+
logo: images/tf_full_color_primary_icon.svg
36+
favicon: images/favicon.png
37+
38+
features:
39+
- content.code.copy
40+
- content.code.select
41+
plugins:
42+
- search
43+
- autorefs
44+
- mkdocstrings:
45+
default_handler: python
46+
handlers:
47+
python:
48+
options:
49+
show_source: true
50+
show_root_heading: true
51+
unwrap_annotated: true
52+
show_symbol_type_toc: true
53+
show_symbol_type_heading: true
54+
merge_init_into_class: true
55+
show_signature_annotations: true
56+
separate_signature: true
57+
signature_crossrefs: true
58+
group_by_category: true
59+
show_category_heading: true
60+
inherited_members: true
61+
show_submodules: true
62+
show_object_full_path: false
63+
show_root_full_path: true
64+
docstring_section_style: "spacy"
65+
summary: true
66+
filters:
67+
- "!^_"
68+
- "^__init__$"
69+
- "^__call__$"
70+
- "!^logger"
71+
- "!_test$"
72+
extensions:
73+
- griffe_inherited_docstrings
74+
import:
75+
- https://docs.python.org/3/objects.inv
76+
- caption:
77+
figure:
78+
ignore_alt: true
79+
80+
markdown_extensions:
81+
- admonition
82+
- attr_list
83+
- toc:
84+
permalink: true
85+
- pymdownx.highlight:
86+
anchor_linenums: true
87+
linenums: false
88+
line_spans: __span
89+
pygments_lang_class: true
90+
- pymdownx.inlinehilite
91+
- pymdownx.snippets
92+
- pymdownx.superfences
93+
- pymdownx.arithmatex:
94+
generic: true
95+
- md_in_html
96+
- pymdownx.emoji:
97+
emoji_index: !!python/name:material.extensions.emoji.twemoji
98+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
99+
100+
extra_css:
101+
- stylesheets/extra.css
102+
103+
extra_javascript:
104+
- javascripts/mathjax.js
105+
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
106+
107+
watch:
108+
- tensorflow_serving
109+
nav:
110+
- Guide:
111+
- serving.md
112+
- docker.md
113+
- setup.md
114+
- serving_basic.md
115+
- architecture.md
116+
- serving_config.md
117+
- serving_advanced.md
118+
- serving_kubernetes.md
119+
- custom_servable.md
120+
- custom_source.md
121+
- custom_op.md
122+
- signature_defs.md

‎tensorflow_serving/g3doc/images/favicon.png

404 Bytes
Loading

‎tensorflow_serving/g3doc/images/tf_full_color_primary_icon.svg

Lines changed: 1 addition & 0 deletions
Loading

‎tensorflow_serving/g3doc/javascripts/mathjax.js

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
window.MathJax = {
2+
tex: {
3+
inlineMath: [["\\(", "\\)"]],
4+
displayMath: [["\\[", "\\]"]],
5+
processEscapes: true,
6+
processEnvironments: true
7+
},
8+
options: {
9+
ignoreHtmlClass: ".*|",
10+
processHtmlClass: "arithmatex"
11+
}
12+
};
13+
14+
document$.subscribe(() => {
15+
MathJax.startup.output.clearCache()
16+
MathJax.typesetClear()
17+
MathJax.texReset()
18+
MathJax.typesetPromise()
19+
})

‎tensorflow_serving/g3doc/serving.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Serving Models
2+
3+
## Introduction
4+
5+
TensorFlow Serving is a flexible, high-performance serving system for machine learning models, designed for production environments. TensorFlow Serving makes it easy to deploy new algorithms and experiments, while keeping the same server architecture and APIs. TensorFlow Serving provides out-of-the-box integration with TensorFlow models, but can be easily extended to serve other types of models and data.
6+
7+
Detailed developer documentation on TensorFlow Serving is available:
8+
9+
- Architecture Overview
10+
- Server API
11+
- REST Client API
12+
<!-- TODO: fix the above bullet points with links -->

‎tensorflow_serving/g3doc/stylesheets/extra.css

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:root {
2+
--md-primary-fg-color: #FFA800;
3+
--md-primary-fg-color--light: #CCCCCC;
4+
--md-primary-fg-color--dark: #425066;
5+
}
6+
7+
.video-wrapper {
8+
max-width: 240px;
9+
display: flex;
10+
flex-direction: row;
11+
}
12+
.video-wrapper > iframe {
13+
width: 100%;
14+
aspect-ratio: 16 / 9;
15+
}

0 commit comments

Comments
 (0)