-
Notifications
You must be signed in to change notification settings - Fork 520
Docs: Add extended quickstart and installation guides (release + source) #2388
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
Open
yiseungmi87
wants to merge
2
commits into
apache:main
Choose a base branch
from
yiseungmi87:docs/extended-quickstart
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+702
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Extended Quickstart Guide | ||
|
|
||
| Welcome to the extended quickstart guide for Apache SystemDS. This quickstart page provides a high-level overview of both installation and points you to the detailed documentation for each path. | ||
|
|
||
| SystemDS can be installed and used in two different ways: | ||
|
|
||
| 1. Using a **downloaded release** | ||
| 2. Using a **source build** | ||
|
|
||
| If you are primarily a user of SystemDS, start with the Release installation. If you plan to contribute or modify internals, follow the Source installation. | ||
|
|
||
| Each method is demonstrated in: | ||
| - Local mode | ||
| - Spark mode | ||
| - Federated mode (simple example) | ||
|
|
||
| For detailed configuration topics (BLAS, GPU, federated setup, contributing), see the links at the end. | ||
|
|
||
| --- | ||
|
|
||
| # 1. Install from a Release | ||
|
|
||
| If you simply want to *use* SystemDS without modifying the source code, the recommended approach is to install SystemDS from an official Apache release. | ||
|
|
||
| **Full Release Installation Guide:** [SystemDS Install from release](https://apache.github.io/systemds/site/release_install.html) | ||
|
|
||
| # 2. Install from Source | ||
|
|
||
| If you plan to contribute to SystemDS or need to modify its internals, you can build SystemDS from source. | ||
|
|
||
| **Full Source Build Guide:** [SystemDS Install from source](https://apache.github.io/systemds/site/source_install.html) | ||
|
|
||
| # 3. After Installation | ||
|
|
||
| Once either installation path is completed, you can start running scripts: | ||
|
|
||
| - Local Mode - Run SystemDS locally | ||
| - Spark Mode - Execute scripts on Spark through `spark-submit` | ||
| - Federated Mode - Run operations on remote data using federated workers | ||
|
|
||
| For detailed commands and examples: [Execute SystemDS](https://apache.github.io/systemds/site/run_extended.html) | ||
|
|
||
| # 4. More Configuration | ||
|
|
||
| SystemDS provides advanced configuration options for performance tuning and specialized execution environments. | ||
|
|
||
| - GPU Support — [GPU Guide](https://apache.github.io/systemds/site/gpu) | ||
| - BLAS / Native Acceleration — [Native Backend (BLAS) Guide](https://apache.github.io/systemds/site/native-backend) | ||
| - Federated Backend Deployment — [Federated Guide](https://apache.github.io/systemds/site/federated-monitoring.html) | ||
| - Contributing to SystemDS — [Contributing Guide](https://github.com/apache/systemds/blob/main/CONTRIBUTING.md) | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,210 @@ | ||
|
|
||
| # Install SystemDS from a Release | ||
|
|
||
| This guide explains how to install and set up SystemDS using the pre-built release archives. | ||
|
|
||
| --- | ||
|
|
||
| - [1. Download a Release](#1-download-a-release) | ||
| - [2. Install on Windows](#2-install-on-windows) | ||
| - [3. Install on Ubuntu 22.04](#3-install-on-ubuntu-2204) | ||
| - [4. Install on macOS](#4-install-on-macos) | ||
|
|
||
| --- | ||
|
|
||
| # 1. Download a Release | ||
|
|
||
| Download the official release archive from the Apache SystemDS website: | ||
|
|
||
| https://systemds.apache.org/download | ||
|
|
||
| After downloading the file `systemds-<VERSION>.tar.gz`, place the file in any directory you choose for installation. | ||
|
|
||
| ### Java Requirement ### | ||
| For compatability with Spark execution and parser components, **Java 17** is strongly recommended for SystemDS. | ||
|
|
||
| Verify Java 17: | ||
|
|
||
| ```bash | ||
| java -version | ||
| ``` | ||
|
|
||
| If missing, install a JDK 17 distribution. | ||
|
|
||
| --- | ||
|
|
||
| # 2. Install on Windows | ||
|
|
||
| ### 2.1 Extract the Release Archive | ||
|
|
||
| Use Windows built-in extractor. | ||
|
|
||
| ### 2.2 Set Evironment Variables | ||
|
|
||
| To run SystemDS from the command line, configure: | ||
| - `SYSTEMDS_ROOT`-> the extracted folder | ||
| - Add `%SYSTEMDS_ROOT%\bin` to your `PATH` | ||
|
|
||
| Example (PowerShell): | ||
| ```bash | ||
| setx SYSTEMDS_ROOT "C:\path\to\systemds-<VERSION>" | ||
| setx PATH "$env:SYSTEMDS_ROOT\bin;$env:PATH" | ||
| ``` | ||
|
|
||
| Restart the terminal afterward. | ||
|
|
||
| ### 2.3 Verify the Installation by Checking the CLI | ||
|
|
||
| On Windows, the `systemds`CLI wrapper may not be executable. This is expected because the `bin/systemds`launcher is implemented as a shell script, which Windows cannot execute natively. To verify the installation on Windows, navigate to the bin directory and run the JAR directly. Note that running `systemds -help` without JAR may result in a CommandNotFoundExeption: | ||
|
|
||
| ```bash | ||
| java -jar systemds-3.3.0.jar -help | ||
| ``` | ||
|
|
||
| You should see usage information as an output printed to the console. | ||
|
|
||
| ### 2.4 Create a Simple Script | ||
|
|
||
| On Windows, especially when using PowerShell, creating text files via shell redirection (e.g., echo...) may result in unexpected encoding or invisible characters. This can lead to parsing errors when executing the script, even though the file appears correct in an editor. Therefore, you may try creating the file explicitly using PowerShell: | ||
| ```bash | ||
| Set-Content -Path .\hello.dml -Value 'print("Hello World!")' -Encoding Ascii | ||
| ``` | ||
|
|
||
| This ensures the script is stored as plain text without additional encoding metadata. | ||
| Note: This behavior depends on the shell and environment configuration and may not affect all Windows setups. | ||
|
|
||
| Verify the file contents: | ||
| ```bash | ||
| Get-Content .\hello.dml | ||
| ``` | ||
|
|
||
| Expected output: | ||
| ```bash | ||
| print("Hello World!") | ||
| ``` | ||
|
|
||
| ### 2.5 Run the Script | ||
|
|
||
| Now run the script: | ||
| ```bash | ||
| java -jar systemds-3.3.0.jar -f .\hello.dml | ||
| ``` | ||
|
|
||
| Expected output: | ||
| ```bash | ||
| Hello World! | ||
| SystemDS Statistics: | ||
| Total execution time: 0.012 sec. | ||
| ``` | ||
|
|
||
| # 3. Install on Ubuntu 22.04 | ||
|
|
||
| ### 3.1 Extract the Release | ||
|
|
||
| ```bash | ||
| cd /path/to/install | ||
| tar -xvf systemds-<VERSION>-bin.tgz | ||
| cd systemds-<VERSION>-bin | ||
| ``` | ||
|
|
||
| ### 3.2 Add SystemDS to PATH | ||
|
|
||
| ```bash | ||
| export SYSTEMDS_ROOT=$(pwd) | ||
| export PATH="$SYSTEMDS_ROOT/bin:$PATH" | ||
| ``` | ||
|
|
||
| (Optional but recommended) To make SystemDS available in new terminals, add the following lines to your shell configuration (e.g., ~/.bashrc or ~/.profile): | ||
| ```bash | ||
| export SYSTEMDS_ROOT=/absolute/path/to/systemds-<VERSION> | ||
| export PATH=$SYSTEMDS_ROOT/bin:$PATH | ||
| ``` | ||
|
|
||
| ### 3.3 Verify the Installation by Checking the CLI | ||
|
|
||
| ```bash | ||
| systemds -help | ||
| ``` | ||
|
|
||
| You should see usage information printed to the console. | ||
|
|
||
| ### 3.4 Create a Simple Script | ||
|
|
||
| ```bash | ||
| echo 'print("Hello World!")' > hello.dml | ||
| ``` | ||
|
|
||
| ### 3.5 Run the Script | ||
|
|
||
| On some Ubuntu setups (including clean Docker images), running SystemDS directly may fail with `Invalid or corrupt jarfile hello.dml` Error. In this case, explicitly pass the SystemDS JAR shipped with the release. | ||
|
|
||
| Locate the JAR in the release root: | ||
| ```bash | ||
| SYSTEMDS_JAR=$(find "$SYSTEMDS_ROOT" -maxdepth 1 -type f -name "systemds-*.jar" | head -n 1) | ||
| echo "Using SystemDS JAR: $SYSTEMDS_JAR" | ||
| ``` | ||
|
|
||
| Then run: | ||
| ```bash | ||
| systemds "$SYSTEMDS_JAR" -f hello.dml | ||
| ``` | ||
|
Comment on lines
+139
to
+150
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The core issue is that the script requires an exported |
||
|
|
||
| Expected output: | ||
| ```bash | ||
| Hello World! | ||
| ``` | ||
|
|
||
| # 4. Install on macOS | ||
|
|
||
| ### 4.1 Extract the Release | ||
|
|
||
| ```bash | ||
| cd /path/to/install | ||
| tar -xvf systemds-<VERSION>-bin.tgz | ||
| cd systemds-<VERSION>-bin | ||
| ``` | ||
| ### 4.2 Add SystemDS to PATH | ||
|
|
||
| ```bash | ||
| export SYSTEMDS_ROOT=$(pwd) | ||
| export PATH="$SYSTEMDS_ROOT/bin:$PATH" | ||
| ``` | ||
|
|
||
| (Optional but recommended) | ||
| To make SystemDS available in new terminals, add the following lines | ||
| to your shell configuration (e.g., ~/.bashrc or ~/.profile): | ||
| ```bash | ||
| export SYSTEMDS_ROOT=/absolute/path/to/systemds-<VERSION> | ||
| export PATH=$SYSTEMDS_ROOT/bin:$PATH | ||
| ``` | ||
|
|
||
| ### 4.3 Verify the Installation by Checking the CLI | ||
|
|
||
| ```bash | ||
| systemds -help | ||
| ``` | ||
|
|
||
| You should see usage information printed to the console. | ||
|
|
||
| ### 4.4 Create a Simple Script | ||
|
|
||
| ```bash | ||
| echo 'print("Hello World!")' > hello.dml | ||
| ``` | ||
|
|
||
| ### 4.5 Run the Script | ||
|
|
||
| ```bash | ||
| systemds -f hello.dml | ||
| ``` | ||
|
|
||
| Expected output: | ||
|
|
||
| ```bash | ||
| Hello World! | ||
| ``` | ||
|
|
||
| # Next Steps | ||
|
|
||
| For running scripts in Spark mode or experimenting with federated workers, see the Execution Guide: [Execute SystemDS](run_extended.md) | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This step is unnecessary as we don't use the
systemdsscript anyway