Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates doc versions to 0.24.0 #2829

Merged
merged 2 commits into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion android/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In gradle, you can add the 5 modules in your dependencies:

```groovy
dependencies {
implementation platform("ai.djl:bom:0.23.0")
implementation platform("ai.djl:bom:0.24.0")

implementation "ai.djl:api"
implementation "ai.djl.android:core"
Expand Down
4 changes: 2 additions & 2 deletions android/pytorch-native/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ cd ..
./gradlew compileAndroidJNI -Ppt_version=${PYTORCH_VERSION}
```

`jnilib/0.23.0/android` folder will be created after build, and shared library will be uploaded to S3 in CI build
`jnilib/0.24.0/android` folder will be created after build, and shared library will be uploaded to S3 in CI build

## Build PyTorch android library (.aar) and publish to Sonatype snapshot repo

Expand All @@ -138,7 +138,7 @@ cd ../../../android

# To avoid download jni from S3, manually copy them
mkdir -p pytorch-native/jnilib
cp -r ../engines/pytorch/pytorch-native/jnilib/0.23.0/android/* pytorch-native/jnilib
cp -r ../engines/pytorch/pytorch-native/jnilib/0.24.0/android/* pytorch-native/jnilib

./gradlew :pytorch-native:assemble
# publish to local maven repo (~/.m2 folder)
Expand Down
2 changes: 1 addition & 1 deletion api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You can pull the DJL API from the central Maven repository by including the foll
<dependency>
<groupId>ai.djl</groupId>
<artifactId>api</artifactId>
<version>0.23.0</version>
<version>0.24.0</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion basicdataset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You can pull the module from the central Maven repository by including the follo
<dependency>
<groupId>ai.djl</groupId>
<artifactId>basicdataset</artifactId>
<version>0.23.0</version>
<version>0.24.0</version>
</dependency>
```

Expand Down
6 changes: 3 additions & 3 deletions bom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ will need to mention the type as pom and the scope as import) as the following:
<dependency>
<groupId>ai.djl</groupId>
<artifactId>bom</artifactId>
<version>0.23.0</version>
<version>0.24.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand All @@ -38,7 +38,7 @@ will need to mention the type as pom and the scope as import) as the following:
<dependency>
<groupId>ai.djl</groupId>
<artifactId>bom</artifactId>
<version>0.23.0</version>
<version>0.24.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand All @@ -65,7 +65,7 @@ will need to mention the type as pom and the scope as import) as the following:
- First you need add BOM into your build.gradle file as the following:

```
implementation platform("ai.djl:bom:0.23.0")
implementation platform("ai.djl:bom:0.24.0")
```

- Then you import the desired DJL modules into to you pom.xml file (no version is needed):
Expand Down
2 changes: 1 addition & 1 deletion djl-zero/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ You can pull the module from the central Maven repository by including the follo
<dependency>
<groupId>ai.djl</groupId>
<artifactId>djl-zero</artifactId>
<version>0.23.0</version>
<version>0.24.0</version>
</dependency>
```
2 changes: 1 addition & 1 deletion docker/spark/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ FROM 314815235551.dkr.ecr.us-east-2.amazonaws.com/sagemaker-spark-processing:3.3
LABEL maintainer="[email protected]"

# Install dependencies
ARG DJL_VERSION=0.23.0
ARG DJL_VERSION=0.24.0
ARG JNA_VERSION=5.13.0
ARG JAVACV_VERSION=1.5.9
ARG JAVACPP_VERSION=1.5.9
Expand Down
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.23.0"
api "ai.djl:basicdataset:0.23.0"
api "ai.djl:api:0.24.0"
api "ai.djl:basicdataset:0.24.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.23.0"
runtimeOnly "ai.djl.mxnet:mxnet-engine:0.24.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.23.0"
runtimeOnly "ai.djl.pytorch:pytorch-engine:0.24.0"
```

```
runtimeOnly "ai.djl.tensorflow:tensorflow-engine:0.23.0"
runtimeOnly "ai.djl.tensorflow:tensorflow-engine:0.24.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.23.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.24.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.23.0
- ai.djl.ml.lightgbm:lightgbm:0.24.0

```xml
<dependency>
<groupId>ai.djl.ml.lightgbm</groupId>
<artifactId>lightgbm</artifactId>
<version>0.23.0</version>
<version>0.24.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.23.0
- ai.djl.ml.xgboost:xgboost:0.24.0

```xml
<dependency>
<groupId>ai.djl.ml.xgboost</groupId>
<artifactId>xgboost</artifactId>
<version>0.23.0</version>
<version>0.24.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.23.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.24.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.23.0</version>
<version>0.24.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.23.0</version>
<version>0.24.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.23.0
- ai.djl.android:onnxruntime:0.24.0

```xml
<dependency>
<groupId>ai.djl.android</groupId>
<artifactId>onnxruntime</artifactId>
<version>0.23.0</version>
<version>0.24.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.23.0
- ai.djl.onnxruntime:onnxruntime-engine:0.24.0

```xml
<dependency>
<groupId>ai.djl.onnxruntime</groupId>
<artifactId>onnxruntime-engine</artifactId>
<version>0.23.0</version>
<version>0.24.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.23.0</version>
<version>0.24.0</version>
<scope>runtime</scope>
<exclusions>
<exclusion>
Expand All @@ -81,7 +81,7 @@ Maven:
Gradle:

```groovy
implementation("ai.djl.onnxruntime:onnxruntime-engine:0.23.0") {
implementation("ai.djl.onnxruntime:onnxruntime-engine:0.24.0") {
exclude group: "com.microsoft.onnxruntime", module: "onnxruntime"
}
implementation "com.microsoft.onnxruntime:onnxruntime_gpu:1.14.0"
Expand Down
2 changes: 1 addition & 1 deletion engines/paddlepaddle/paddlepaddle-engine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can pull the PaddlePaddle engine from the central Maven repository by includ
<dependency>
<groupId>ai.djl.paddlepaddle</groupId>
<artifactId>paddlepaddle-engine</artifactId>
<version>0.23.0</version>
<version>0.24.0</version>
<scope>runtime</scope>
</dependency>
```
Expand Down
2 changes: 1 addition & 1 deletion engines/paddlepaddle/paddlepaddle-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.paddlepaddle</groupId>
<artifactId>paddlepaddle-model-zoo</artifactId>
<version>0.23.0</version>
<version>0.24.0</version>
</dependency>
```

Expand Down
Loading
Loading