Skip to content

Commit 45091f4

Browse files
committed
Add section to readme
Signed-off-by: Ryan Nett <rnett@calpoly.edu>
1 parent b01db78 commit 45091f4

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,13 @@ The following describes the layout of the repository and its different artifacts
2121
* `tensorflow-core`
2222
* All artifacts that build up the core language bindings of TensorFlow for Java
2323
* Intended audience: projects that provide their own APIs or frameworks on top of
24-
TensorFlow and just want a thin layer to access the TensorFlow runtime from the JVM
24+
TensorFlow and just want a thin layer to access the TensorFlow runtime from the JVM
2525

26+
* `tensorflow-core-kotlin`
27+
* Kotlin API bindings for `tensorflow-core`. These are thin wrappers around the core APIs
28+
to make them more idiomatic for use in Kotlin, such as using parameters with default values
29+
operation builders instead of an `Options` vararg.
30+
2631
* `tensorflow-framework`
2732
* Primary API for building and training neural networks with TensorFlow
2833
* Intended audience: neural network developers
@@ -112,6 +117,12 @@ the platforms you are targeting. For this purpose the `-platform` artifacts incl
112117
the conventions established on this page:
113118
* [Reducing the Number of Dependencies](https://github.com/bytedeco/javacpp-presets/wiki/Reducing-the-Number-of-Dependencies)
114119

120+
### Kotlin API
121+
122+
Since the Kotlin API is just a wrapper of the Java API, it uses the Java platform artifacts instead of providing its own.
123+
To use, follow the instructions above for the Java API, but add `tensorflow-core-kotlin-api`,
124+
replacing `tensorflow-core-api` if you have explicitly included it.
125+
115126
### Snapshots
116127

117128
Snapshots of TensorFlow Java artifacts are automatically distributed after each update in the code. To use them, you need

0 commit comments

Comments
 (0)