Skip to content

Commit 5a9a308

Browse files
karllessardkarllessard
committed
Add docs nav and landing page
1 parent b587817 commit 5a9a308

File tree

8 files changed

+135
-23
lines changed

8 files changed

+135
-23
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,6 @@ gradleBuild
6464
# Deployment Files
6565
settings.xml
6666
pom.xml.asc
67+
68+
# Docs
69+
docs/docs/apidocs/

‎docs/_toc.yaml‎

100644100755
File mode changed.

‎docs/docs/assets/tensorflow.svg‎

Lines changed: 1 addition & 0 deletions
Loading

docs/index.md renamed to docs/docs/index.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
11
# TensorFlow for Java
22

3-
<table class="tfo-notebook-buttons" align="left">
4-
<td>
5-
<a target="_blank" href="https://www.tensorflow.org/jvm"><img src="https://www.tensorflow.org/images/tf_logo_32px.png" />View on TensorFlow.org</a>
6-
</td>
7-
<td>
8-
<a target="_blank" href="https://github.com/tensorflow/java"><img src="https://www.tensorflow.org/images/GitHub-Mark-32px.png" />View GitHub repository</a>
9-
</td>
10-
</table>
11-
123
TensorFlow Java can run on any JVM for building, training and running machine learning models. It comes with
134
a series of utilities and frameworks that help achieve most of the tasks common to data scientists
145
and developers working in this domain. Java and other JVM languages, such as Scala or Kotlin, are
@@ -26,21 +17,19 @@ migrated from Bazel to Maven, which is more familiar for most Java developers.
2617

2718
The following describes the layout of the repository and its different artifacts:
2819

29-
* [tensorflow-core](https://github.com/tensorflow/java/tree/master/tensorflow-core)
30-
* All artifacts that build up the core language bindings of TensorFlow for Java
31-
* Intended audience: projects that provide their own APIs or frameworks on top of
32-
TensorFlow and just want a thin layer to access the TensorFlow runtime from the JVM
33-
34-
* [tensorflow-framework](https://github.com/tensorflow/java/tree/master/tensorflow-framework)
35-
* Primary API for building and training neural networks with TensorFlow
36-
* Intended audience: neural network developers
20+
### [tensorflow-core](https://github.com/tensorflow/java/tree/master/tensorflow-core)
21+
* **Intended audience**: developers who wants to deploy a TensorFlow model on a JVM for inference. Also for projects
22+
that provide their own APIs or frameworks on top of TensorFlow and just want a thin layer to access the TensorFlow runtime from the JVM.
23+
* All artifacts that make up the core language bindings of TensorFlow for Java.
3724

38-
* [ndarray](https://github.com/tensorflow/java-ndarray)
39-
* Generic utility library for n-dimensional data I/O operations
40-
* Used by TensorFlow but does not depend on TensorFlow
41-
* Intended audience: any developer who needs a Java n-dimensional array implementation, whether or not they
42-
use it with TensorFlow
25+
### [tensorflow-framework](https://github.com/tensorflow/java/tree/master/tensorflow-framework)
26+
* **Intended audience**: neural network developers.
27+
* Primary API for building and training neural networks with TensorFlow.
4328

29+
### [ndarray](https://github.com/tensorflow/java-ndarray)
30+
* **Intended audience**: any developer who needs a Java n-dimensional array implementation, whether or not they use it with TensorFlow.
31+
* Generic utility library for n-dimensional data I/O operations.
32+
* Used by TensorFlow but does not depend on TensorFlow.
4433

4534
## Communication
4635

docs/install.md renamed to docs/docs/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ TensorFlow Java 1.0 series and earlier releases also have binaries for:
2626
* macOS 12 or higher; 64-bit, x86
2727

2828
*Note: To use TensorFlow on Android, see
29-
[TensorFlow Lite](https://tensorflow.org/lite)*
29+
[TensorFlow LiteRT](https://tensorflow.org/lite)*
3030

3131
## Versions
3232

‎docs/docs/references.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
- title
6+
---
7+
#
8+
<iframe src="https://tensorflow.github.io/java/javadoc/v1.2.0/index.html" style="width:100%; height:800px; border:none;"></iframe>

‎docs/docs/stylesheets/extra.css‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
:root > * {
2+
/*--md-primary-fg-color: #EE782F;*/
3+
/*--md-primary-fg-color--light: #455960;*/
4+
/*--md-primary-fg-color--dark: #90030C;*/
5+
}
6+
7+
.md-typeset h1, .md-typeset h2 {
8+
font-weight: 800;
9+
letter-spacing: -.01em;
10+
}
11+
12+
.md-sidebar--primary {
13+
display: none;
14+
}

‎docs/mkdocs.yml‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
site_name: ''
2+
site_url: https://tensorflow.org
3+
repo_url: https://github.com/tensorflow/java
4+
site_description: Documentation of TensorFlow Java API and tools.
5+
copyright: "&copy; TensorFlow Authors 2025"
6+
7+
theme:
8+
name: material
9+
logo: assets/tensorflow.svg
10+
features:
11+
- navigation.indexes
12+
- navigation.instant
13+
- navigation.sections
14+
- navigation.tabs
15+
- navigation.tabs.sticky
16+
- toc.follow
17+
palette:
18+
# Palette toggle for automatic mode
19+
- media: "(prefers-color-scheme)"
20+
toggle:
21+
icon: material/brightness-auto
22+
name: Switch to light mode
23+
# Palette toggle for light mode
24+
- media: "(prefers-color-scheme: light)"
25+
scheme: default
26+
primary: white
27+
accent: orange
28+
toggle:
29+
icon: material/brightness-7
30+
name: Switch to dark mode
31+
# Palette toggle for dark mode
32+
- media: "(prefers-color-scheme: dark)"
33+
scheme: slate
34+
primary: black
35+
accent: orange
36+
toggle:
37+
icon: material/brightness-4
38+
name: Switch to system preference
39+
40+
extra_css:
41+
- stylesheets/extra.css
42+
43+
nav:
44+
- Home:
45+
- index.md
46+
- Install:
47+
- install.md
48+
- References:
49+
- apidocs/index.html
50+
51+
#markdown_extensions:
52+
# - admonition
53+
# - pymdownx.snippets
54+
# - pymdownx.superfences
55+
# - pymdownx.details
56+
# - pymdownx.superfences
57+
# - attr_list
58+
# - md_in_html
59+
# - toc
60+
# - pymdownx.tabbed:
61+
# alternate_style: true
62+
63+
#plugins:
64+
# - search
65+
# - glightbox
66+
# - include-markdown
67+
# - include_dir_to_nav
68+
# - mkdocs-jupyter:
69+
# execute: false
70+
# include_source: true
71+
# - mkdocstrings:
72+
# default_handler: python
73+
# handlers:
74+
# python:
75+
# load_external_modules: false
76+
# options:
77+
# docstring_options:
78+
# ignore_init_summary: true
79+
# docstring_style: google
80+
# members_order: source
81+
# merge_init_into_class: true
82+
# parameter_headings: true
83+
# separate_signature: true
84+
# show_if_no_docstring: true
85+
# show_root_full_path: true
86+
# show_root_heading: false
87+
# show_source: true
88+
# show_symbol_type_heading: true
89+
# show_symbol_type_toc: true
90+
# signature_crossrefs: true
91+
#
92+
#extra:
93+
# generator: false
94+
# social:
95+
# - icon: fontawesome/brands/slack
96+
# link: https://expediagroup.enterprise.slack.com/archives/C08RD5SBRLH
97+
# name: "#ask-genai-platform"

0 commit comments

Comments
 (0)