Skip to content

Commit

Permalink
[KYUUBI apache#6010] Improve Gluten usage documentation
Browse files Browse the repository at this point in the history
# 🔍 Description
## Issue References 🔗

This pull request fixes apache#6010

## Describe Your Solution 🔧

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

## Types of changes 🔖

- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Test Plan 🧪

#### Behavior Without This Pull Request ⚰️

#### Behavior With This Pull Request 🎉

#### Related Unit Tests

---

# Checklist 📝

- [ ] This patch was not authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html)

**Be nice. Be informative.**

Closes apache#6011 from huangxiaopingRD/gluten-doc.

Closes apache#6010

88bce58 [huangxiaoping] [KYUUBI apache#6010] Improve Gluten usage documentation

Authored-by: huangxiaoping <[email protected]>
Signed-off-by: Cheng Pan <[email protected]>
  • Loading branch information
huangxiaopingRD authored and pan3793 committed Jan 24, 2024
1 parent ac388d1 commit 083f3c1
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/deployment/spark/gluten.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

# Gluten

Gluten is a Spark plugin developed by Intel, designed to accelerate Apache Spark with native libraries. Currently, only CentOS 7/8 and Ubuntu 20.04/22.04, along with Spark 3.2/3.3/3.4, are supported. Users can employ the following methods to utilize the Gluten with Velox native libraries.
[Gluten](https://oap-project.github.io/gluten/) is a Spark plugin developed by Intel, designed to accelerate Apache Spark with native libraries. Currently, only CentOS 7/8 and Ubuntu 20.04/22.04, along with Spark 3.2/3.3/3.4, are supported. Users can employ the following methods to utilize the Gluten with Velox native libraries.

## Building(with velox Backend)

Expand All @@ -40,11 +40,11 @@ You can use Gluten to accelerate Spark by following steps.

### Installing

add gluten jar: `copy /path/to/gluten/package/target/gluten-velox-bundle-spark3.x_2.12-*.jar $SPARK_HOME/jars/` or specified to `spark.jars` configuration
Add gluten jar: `copy /path/to/gluten/package/target/gluten-velox-bundle-spark3.x_2.12-*.jar $SPARK_HOME/jars/` or specified to `spark.jars` configuration

### Configure

add config into `spark-defaults.conf`:
Add the following minimal configuration into `spark-defaults.conf`:

```properties
spark.plugins=io.glutenproject.GlutenPlugin
Expand All @@ -53,3 +53,4 @@ spark.memory.offHeap.enabled=true
spark.shuffle.manager=org.apache.spark.shuffle.sort.ColumnarShuffleManager
```

For more configuration can be found in the doc of [Configuration](https://oap-project.github.io/gluten/Configuration.html).

0 comments on commit 083f3c1

Please sign in to comment.