Skip to content

Commit c484d92

Browse files
committed
[DOCS] Update Docs to Specify Java 17
1 parent 499b6e3 commit c484d92

File tree

7 files changed

+29
-30
lines changed

7 files changed

+29
-30
lines changed

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The Documentation is separated into different parts by sub folders.
6262

6363
and install any other missing packages
6464

65-
4. Make sure Maven and [Java 11 and above](https://www.java.com/releases/) are installed.
65+
4. Make sure Maven and [Java 17 and above](https://www.java.com/releases/) are installed.
6666

6767
```bash
6868
mvn --version

docs/api/python/sources/getting_started/install.rst.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ Installation is quite simple with `pip`, just execute the following command::
3434
pip install systemds
3535

3636
SystemDS is a java-project, the `pip` package contains all the necessary `jars`,
37-
but you will need java version 11 installed. Do not use an older or newer
37+
but you will need java version 17 installed. Do not use an older or newer
3838
version of java, because SystemDS is non compatible with other java versions.
3939

4040
Check the output of ``java -version``. The output should look similar to::
4141

42-
openjdk version "11.0.18" 2023-01-17
43-
OpenJDK Runtime Environment (build 11.0.18+10-post-Ubuntu-0ubuntu122.04)
44-
OpenJDK 64-Bit Server VM (build 11.0.18+10-post-Ubuntu-0ubuntu122.04, mixed mode, sharing)
42+
openjdk 17.0.11 2024-04-16
43+
OpenJDK Runtime Environment Temurin-17.0.11+9 (build 17.0.11+9)
44+
OpenJDK 64-Bit Server VM Temurin-17.0.11+9 (build 17.0.11+9, mixed mode, sharing)
4545

4646
The important part is in the first line ``openjdk version "11.xx"``,
4747
please make sure this is the case.
@@ -56,7 +56,7 @@ Install Dependencies
5656

5757
- `Maven <https://maven.apache.org/>`_
5858
- `Python 3.6+ <https://www.python.org/downloads/>`_ and
59-
- `OpenJDK 11.xxx Java <https://openjdk.java.net/install/>`_
59+
- `OpenJDK 17.xxx Java <https://openjdk.java.net/install/>`_
6060

6161
Once installed you please verify your version numbers.
6262
Additionally you have to install a few python packages.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ SystemDS's distinguishing characteristics are:
2828
2. **Multiple execution modes**, including Spark MLContext, Spark Batch, Standalone, and JMLC.
2929
3. **Automatic optimization** based on data and cluster characteristics to ensure both efficiency and scalability.
3030

31-
This version of SystemDS supports: Java 11, Python 3.5+, Hadoop 3.3.x, and Spark 3.5.x, Nvidia CUDA 10.2
31+
This version of SystemDS supports: Java 17, Python 3.5+, Hadoop 3.3.x, and Spark 3.5.x, Nvidia CUDA 10.2
3232
(CuDNN 7.x) Intel MKL (<=2019.x).
3333

3434
## Links

docs/site/install.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Once the individual versions is set up skip to the common part of building the s
4141

4242
### Windows
4343

44-
First setup java and maven to compile the system note the java version is 11, we suggest using Java OpenJDK 11.
44+
First setup java and maven to compile the system note the java version is 17, we suggest using Java OpenJDK 17.
4545

4646
- <https://openjdk.org/>
4747
- <https://maven.apache.org/download.cgi?.>
@@ -62,10 +62,10 @@ A suggested starting point would be to run some of the component tests from your
6262

6363
### Ubuntu 22.04
6464

65-
First setup java and maven to compile the system note that the java version is 11.
65+
First setup java and maven to compile the system note that the java version is 17.
6666

6767
```bash
68-
sudo apt install openjdk-11-jdk
68+
sudo apt install openjdk-17-jdk
6969
sudo apt install maven
7070
```
7171

@@ -79,15 +79,15 @@ mvn -version
7979
This should return something like:
8080

8181
```bash
82-
openjdk 11.0.17 2022-10-18
83-
OpenJDK Runtime Environment (build 11.0.17+8-post-Ubuntu-1ubuntu220.04)
84-
OpenJDK 64-Bit Server VM (build 11.0.17+8-post-Ubuntu-1ubuntu220.04, mixed mode, sharing)
82+
openjdk 17.0.11 2024-04-16
83+
OpenJDK Runtime Environment Temurin-17.0.11+9 (build 17.0.11+9)
84+
OpenJDK 64-Bit Server VM Temurin-17.0.11+9 (build 17.0.11+9, mixed mode, sharing)
8585

86-
Apache Maven 3.6.3
87-
Maven home: /usr/share/maven
88-
Java version: 1.8.0_252, vendor: Private Build, runtime: /usr/lib/jvm/java-8-openjdk-amd64/jre
86+
Apache Maven 3.9.9 (8e8579a9e76f7d015ee5ec7bfcdc97d260186937)
87+
Maven home: /home/usr/Programs/maven
88+
Java version: 17.0.11, vendor: Eclipse Adoptium, runtime: /home/usr/Programs/jdk-17.0.11+9
8989
Default locale: en_US, platform encoding: UTF-8
90-
OS name: "linux", version: "5.4.0-37-generic", arch: "amd64", family: "unix"
90+
OS name: "linux", version: "6.8.0-59-generic", arch: "amd64", family: "unix"
9191
```
9292

9393
#### Testing
@@ -120,9 +120,8 @@ Prerequisite install homebrew on the device.
120120
```bash
121121
# To allow relative paths:
122122
brew install coreutils
123-
# To install open jdk 11.
124-
brew tap adoptopenjdk/openjdk
125-
brew cask install adoptopenjdk11
123+
# To install open jdk 17.
124+
brew install openjdk@17
126125
# Install maven to enable compilation of SystemDS.
127126
brew install maven
128127
```
@@ -136,10 +135,10 @@ mvn --version
136135

137136
This should print java version.
138137

139-
Note that if you have multiple __java__ versions installed then you have to change the used version to 11, on __both java and javadoc__. This is done by setting the environment variable JAVA_HOME to the install path of open JDK 11 :
138+
Note that if you have multiple __java__ versions installed then you have to change the used version to 17, on __both java and javadoc__. This is done by setting the environment variable JAVA_HOME to the install path of open JDK 17 :
140139

141140
```bash
142-
export JAVA_HOME=`/usr/libexec/java_home -v 11`
141+
export JAVA_HOME=`/usr/libexec/java_home -v 17`
143142
```
144143

145144
For running all tests [r-base](https://cran.r-project.org/bin/macosx/) has to be installed as well since this is used as a secondary system to verify the correctness of our code, but it is not a requirement to enable building the project.

scripts/resource/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export SYSTEMDS_ROOT=$(pwd)
5050
# specific steps for the extension
5151
export PATH=$PATH:$SYSTEMDS_ROOT/scripts/resource/bin
5252
```
53-
The proper execution requires JDK 11 so make sure to export the correct JDK version to `$JAVA_HOME` environmental variable.
53+
The proper execution requires JDK 17 so make sure to export the correct JDK version to `$JAVA_HOME` environmental variable.
5454

5555
### Usage
5656

src/assembly/bin/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ SystemDS is a versatile system for the end-to-end data science lifecycle from da
2727

2828
## Getting started
2929

30-
Requirements for running SystemDS are a bash shell and OpenJDK 11 or a Spark 3.5.x cluster installation (to run distributed jobs).
30+
Requirements for running SystemDS are a bash shell and OpenJDK 17 or a Spark 3.5.x cluster installation (to run distributed jobs).
3131
These requirements should be available via standard system packages in all major Linux distributions
3232
(make sure to have the right JDK version enabled, if you have multiple versions in your system).
3333
For Windows, a bash comes with [git for windows](http://git-scm.com) and OpenJDK builds can be obtained at <http://adoptopenjdk.net>

src/main/python/docs/source/getting_started/install.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,16 @@ Installation is quite simple with `pip`, just execute the following command::
3434
pip install systemds
3535

3636
SystemDS is a java-project, the `pip` package contains all the necessary `jars`,
37-
but you will need java version 11 installed. Do not use an older or newer
37+
but you will need java version 17 installed. Do not use an older or newer
3838
version of java, because SystemDS is non compatible with other java versions.
3939

4040
Check the output of ``java -version``. The output should look similar to::
4141

42-
openjdk version "11.0.18" 2023-01-17
43-
OpenJDK Runtime Environment (build 11.0.18+10-post-Ubuntu-0ubuntu122.04)
44-
OpenJDK 64-Bit Server VM (build 11.0.18+10-post-Ubuntu-0ubuntu122.04, mixed mode, sharing)
42+
openjdk 17.0.11 2024-04-16
43+
OpenJDK Runtime Environment Temurin-17.0.11+9 (build 17.0.11+9)
44+
OpenJDK 64-Bit Server VM Temurin-17.0.11+9 (build 17.0.11+9, mixed mode, sharing)
4545

46-
The important part is in the first line ``openjdk version "11.xx"``,
46+
The important part is in the first line ``openjdk version "17.xx"``,
4747
please make sure this is the case.
4848

4949

@@ -56,7 +56,7 @@ Install Dependencies
5656

5757
- `Maven <https://maven.apache.org/>`_
5858
- `Python 3.6+ <https://www.python.org/downloads/>`_ and
59-
- `OpenJDK 11.xxx Java <https://openjdk.java.net/install/>`_
59+
- `OpenJDK 17.xxx Java <https://openjdk.java.net/install/>`_
6060

6161
Once installed you please verify your version numbers.
6262
Additionally you have to install a few python packages.

0 commit comments

Comments
 (0)