Skip to content

Commit 65e0d32

Browse files
CraigacpCraigacp
committed
Adding documentation landing page.
1 parent 0271d09 commit 65e0d32

File tree

6 files changed

+84
-24
lines changed

6 files changed

+84
-24
lines changed

‎docs/assets/tensorflow.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎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‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ TensorFlow Java 1.0 series and earlier releases also have binaries for:
2525

2626
* macOS 12 or higher; 64-bit, x86
2727

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

3130
## Versions
3231

‎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/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+
}

‎mkdocs.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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

0 commit comments

Comments
 (0)