Skip to content

Commit

Permalink
[docs] Bump up DJL version to 0.28.0 (#3247)
Browse files Browse the repository at this point in the history
  • Loading branch information
frankfliu committed Jun 12, 2024
1 parent 2acbddc commit b548eca
Show file tree
Hide file tree
Showing 26 changed files with 38 additions and 38 deletions.
4 changes: 2 additions & 2 deletions docs/development/example_dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ api group: 'org.apache.commons', name: 'commons-csv', version: '1.7'
In order to extend the dataset, the following dependencies are required:

```
api "ai.djl:api:0.27.0"
api "ai.djl:basicdataset:0.27.0"
api "ai.djl:api:0.28.0"
api "ai.djl:basicdataset:0.28.0"
```

There are four parts we need to implement for CSVDataset.
Expand Down
6 changes: 3 additions & 3 deletions docs/hybrid_engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ to run in a hybrid mode:
To use it along with Apache MXNet for additional API support, add the following two dependencies:

```
runtimeOnly "ai.djl.mxnet:mxnet-engine:0.27.0"
runtimeOnly "ai.djl.mxnet:mxnet-engine:0.28.0"
```

You can also use PyTorch or TensorFlow Engine as the supplemental engine by adding their corresponding dependencies.

```
runtimeOnly "ai.djl.pytorch:pytorch-engine:0.27.0"
runtimeOnly "ai.djl.pytorch:pytorch-engine:0.28.0"
```

```
runtimeOnly "ai.djl.tensorflow:tensorflow-engine:0.27.0"
runtimeOnly "ai.djl.tensorflow:tensorflow-engine:0.28.0"
```

## How Hybrid works
Expand Down
2 changes: 1 addition & 1 deletion docs/load_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ Here is a few tips you can use to help you debug model loading issue:
See [here](development/configure_logging.md#configure-logging-level) for how to enable debug log

#### List models programmatically in your code
You can use [ModelZoo.listModels()](https://javadoc.io/static/ai.djl/api/0.27.0/ai/djl/repository/zoo/ModelZoo.html#listModels--) API to query available models.
You can use [ModelZoo.listModels()](https://javadoc.io/static/ai.djl/api/0.28.0/ai/djl/repository/zoo/ModelZoo.html#listModels--) API to query available models.

#### List available models using DJL command line

Expand Down
4 changes: 2 additions & 2 deletions engines/ml/lightgbm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ LightGBM can only run on top of the Linux/Mac/Windows machine using x86_64.
## Installation
You can pull the LightGBM engine from the central Maven repository by including the following dependency:

- ai.djl.ml.lightgbm:lightgbm:0.27.0
- ai.djl.ml.lightgbm:lightgbm:0.28.0

```xml
<dependency>
<groupId>ai.djl.ml.lightgbm</groupId>
<artifactId>lightgbm</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
<scope>runtime</scope>
</dependency>
```
Expand Down
4 changes: 2 additions & 2 deletions engines/ml/xgboost/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@ XGBoost can only run on top of the Linux/Mac machine. User can build from source
## Installation
You can pull the XGBoost engine from the central Maven repository by including the following dependency:

- ai.djl.ml.xgboost:xgboost:0.27.0
- ai.djl.ml.xgboost:xgboost:0.28.0

```xml
<dependency>
<groupId>ai.djl.ml.xgboost</groupId>
<artifactId>xgboost</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
<scope>runtime</scope>
</dependency>
```
Expand Down
4 changes: 2 additions & 2 deletions engines/mxnet/mxnet-engine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This module contains the Deep Java Library (DJL) EngineProvider for Apache MXNet
We don't recommend that developers use classes in this module directly. Use of these classes
will couple your code with Apache MXNet and make switching between engines difficult. Even so,
developers are not restricted from using engine-specific features. For more information,
see [NDManager#invoke()](https://javadoc.io/static/ai.djl/api/0.27.0/ai/djl/ndarray/NDManager.html#invoke-java.lang.String-ai.djl.ndarray.NDArray:A-ai.djl.ndarray.NDArray:A-ai.djl.util.PairList-).
see [NDManager#invoke()](https://javadoc.io/static/ai.djl/api/0.28.0/ai/djl/ndarray/NDManager.html#invoke-java.lang.String-ai.djl.ndarray.NDArray:A-ai.djl.ndarray.NDArray:A-ai.djl.util.PairList-).

## Documentation

Expand All @@ -33,7 +33,7 @@ You can pull the MXNet engine from the central Maven repository by including the
<dependency>
<groupId>ai.djl.mxnet</groupId>
<artifactId>mxnet-engine</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
<scope>runtime</scope>
</dependency>
```
Expand Down
2 changes: 1 addition & 1 deletion engines/mxnet/mxnet-model-zoo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You can pull the MXNet engine from the central Maven repository by including the
<dependency>
<groupId>ai.djl.mxnet</groupId>
<artifactId>mxnet-model-zoo</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```

Expand Down
4 changes: 2 additions & 2 deletions engines/onnxruntime/onnxruntime-android/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ This module contains the DJL ONNX Runtime engine for Android.
## Installation
You can pull the ONNX Runtime for Android from the central Maven repository by including the following dependency:

- ai.djl.android:onnxruntime:0.27.0
- ai.djl.android:onnxruntime:0.28.0

```xml
<dependency>
<groupId>ai.djl.android</groupId>
<artifactId>onnxruntime</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
<scope>runtime</scope>
</dependency>
```
8 changes: 4 additions & 4 deletions engines/onnxruntime/onnxruntime-engine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@ for the official ONNX Runtime project.
## Installation
You can pull the ONNX Runtime engine from the central Maven repository by including the following dependency:

- ai.djl.onnxruntime:onnxruntime-engine:0.27.0
- ai.djl.onnxruntime:onnxruntime-engine:0.28.0

```xml
<dependency>
<groupId>ai.djl.onnxruntime</groupId>
<artifactId>onnxruntime-engine</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
<scope>runtime</scope>
</dependency>
```
Expand All @@ -61,7 +61,7 @@ Maven:
<dependency>
<groupId>ai.djl.onnxruntime</groupId>
<artifactId>onnxruntime-engine</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
<scope>runtime</scope>
<exclusions>
<exclusion>
Expand All @@ -81,7 +81,7 @@ Maven:
Gradle:

```groovy
implementation("ai.djl.onnxruntime:onnxruntime-engine:0.27.0") {
implementation("ai.djl.onnxruntime:onnxruntime-engine:0.28.0") {
exclude group: "com.microsoft.onnxruntime", module: "onnxruntime"
}
implementation "com.microsoft.onnxruntime:onnxruntime_gpu:1.17.1"
Expand Down
2 changes: 1 addition & 1 deletion engines/pytorch/pytorch-model-zoo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You can pull the PyTorch engine from the central Maven repository by including t
<dependency>
<groupId>ai.djl.pytorch</groupId>
<artifactId>pytorch-model-zoo</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion engines/tensorflow/tensorflow-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ You can pull the TensorFlow core java API from the central Maven repository by i
<dependency>
<groupId>ai.djl.tensorflow</groupId>
<artifactId>tensorflow-api</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```
4 changes: 2 additions & 2 deletions engines/tensorflow/tensorflow-engine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ The javadocs output is built in the `build/doc/javadoc` folder.

You can pull the TensorFlow engine from the central Maven repository by including the following dependency:

- ai.djl.tensorflow:tensorflow-engine:0.27.0
- ai.djl.tensorflow:tensorflow-engine:0.28.0

```xml
<dependency>
<groupId>ai.djl.tensorflow</groupId>
<artifactId>tensorflow-engine</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
<scope>runtime</scope>
</dependency>
```
Expand Down
2 changes: 1 addition & 1 deletion engines/tensorflow/tensorflow-model-zoo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ from the central Maven repository by including the following dependency:
<dependency>
<groupId>ai.djl.tensorflow</groupId>
<artifactId>tensorflow-model-zoo</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```

Expand Down
4 changes: 2 additions & 2 deletions engines/tensorrt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ The javadocs output is generated in the `build/doc/javadoc` folder.
## Installation
You can pull the TensorRT engine from the central Maven repository by including the following dependency:

- ai.djl.tensorrt:tensorrt:0.27.0
- ai.djl.tensorrt:tensorrt:0.28.0

```xml
<dependency>
<groupId>ai.djl.tensorrt</groupId>
<artifactId>tensorrt</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
<scope>runtime</scope>
</dependency>
```
Expand Down
2 changes: 1 addition & 1 deletion extensions/audio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ You can pull the module from the central Maven repository by including the follo
<dependency>
<groupId>ai.djl.audio</groupId>
<artifactId>audio</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```
2 changes: 1 addition & 1 deletion extensions/aws-ai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,6 @@ You can pull the module from the central Maven repository by including the follo
<dependency>
<groupId>ai.djl.aws</groupId>
<artifactId>aws-ai</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```
2 changes: 1 addition & 1 deletion extensions/fasttext/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ You can pull the fastText engine from the central Maven repository by including
<dependency>
<groupId>ai.djl.fasttext</groupId>
<artifactId>fasttext-engine</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```

2 changes: 1 addition & 1 deletion extensions/hadoop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@ You can pull the module from the central Maven repository by including the follo
<dependency>
<groupId>ai.djl.hadoop</groupId>
<artifactId>hadoop</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```
2 changes: 1 addition & 1 deletion extensions/opencv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ You can pull the module from the central Maven repository by including the follo
<dependency>
<groupId>ai.djl.opencv</groupId>
<artifactId>opencv</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```
2 changes: 1 addition & 1 deletion extensions/sentencepiece/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ You can pull the module from the central Maven repository by including the follo
<dependency>
<groupId>ai.djl.sentencepiece</groupId>
<artifactId>sentencepiece</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```
2 changes: 1 addition & 1 deletion extensions/spark/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ You can pull the module from the central Maven repository by including the follo
<dependency>
<groupId>ai.djl.spark</groupId>
<artifactId>spark_2.12</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion extensions/tablesaw/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ You can pull the module from the central Maven repository by including the follo
<dependency>
<groupId>ai.djl.tablesaw</groupId>
<artifactId>tablesaw</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```
2 changes: 1 addition & 1 deletion extensions/timeseries/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,6 @@ You can pull the module from the central Maven repository by including the follo
<dependency>
<groupId>ai.djl.timeseries</groupId>
<artifactId>timeseries</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```
2 changes: 1 addition & 1 deletion extensions/timeseries/docs/forecast_with_M5_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ repositories {
}
dependencies {
implementation "org.apache.logging.log4j:log4j-slf4j-impl:2.17.1"
implementation platform("ai.djl:bom:0.27.0")
implementation platform("ai.djl:bom:0.28.0")
implementation "ai.djl:api"
implementation "ai.djl.timeseries"
runtimeOnly "ai.djl.mxnet:mxnet-engine"
Expand Down
2 changes: 1 addition & 1 deletion extensions/tokenizers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can pull the module from the central Maven repository by including the follo
<dependency>
<groupId>ai.djl.huggingface</groupId>
<artifactId>tokenizers</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion model-zoo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ You can pull the model zoo from the central Maven repository by including the fo
<dependency>
<groupId>ai.djl</groupId>
<artifactId>model-zoo</artifactId>
<version>0.27.0</version>
<version>0.28.0</version>
</dependency>
```

Expand Down

0 comments on commit b548eca

Please sign in to comment.