FelixYBW commented on code in PR #8444: URL: https://github.com/apache/incubator-gluten/pull/8444#discussion_r1906031485
########## README.md: ########## @@ -63,58 +66,42 @@ There are several key components in Gluten: # 3 How to Use -There are two ways to use Gluten. - -# 3.1 Use Released Jar - -One way is to use released jar. Here is a simple example. Currently, only centos7/8 and ubuntu20.04/22.04 are well supported. +Here is a basic configuration to enable Gluten in Spark. ``` -spark-shell \ - --master yarn --deploy-mode client \ - --conf spark.plugins=org.apache.gluten.GlutenPlugin \ - --conf spark.memory.offHeap.enabled=true \ - --conf spark.memory.offHeap.size=20g \ - --conf spark.shuffle.manager=org.apache.spark.shuffle.sort.ColumnarShuffleManager \ - --jars https://github.com/apache/incubator-gluten/releases/download/v1.1.1/gluten-velox-bundle-spark3.2_2.12-ubuntu_20.04_x86_64-1.1.1.jar -``` - -# 3.2 Custom Build - -Alternatively, you can build gluten from source, then do some configurations to enable Gluten plugin for Spark. Here is a simple example. Please refer to the corresponding backend part below for more details. - -``` -export gluten_jar = /PATH/TO/GLUTEN/backends-velox/target/<gluten-jar> +export GLUTEN_JAR=/PATH/TO/GLUTEN_JAR spark-shell \ --master yarn --deploy-mode client \ --conf spark.plugins=org.apache.gluten.GlutenPlugin \ --conf spark.memory.offHeap.enabled=true \ --conf spark.memory.offHeap.size=20g \ - --conf spark.driver.extraClassPath=${gluten_jar} \ - --conf spark.executor.extraClassPath=${gluten_jar} \ + --conf spark.driver.extraClassPath=${GLUTEN_JAR} \ + --conf spark.executor.extraClassPath=${GLUTEN_JAR} \ --conf spark.shuffle.manager=org.apache.spark.shuffle.sort.ColumnarShuffleManager ... ``` -### 3.2.1 Build and install Gluten with Velox backend +There are two ways to acquire Gluten jar. + +# 3.1 Use Released Jar (only applicable to Velox backend) -If you want to use Gluten **Velox** backend, see [Build with Velox](./docs/get-started/Velox.md) to build and install the necessary libraries. +Please download a tar package [here](https://downloads.apache.org/incubator/gluten/), then extract out Gluten jar from it. -### 3.2.2 Build and install Gluten with ClickHouse backend +# 3.2 Custom Build -If you want to use Gluten **ClickHouse** backend, see [Build with ClickHouse Backend](./docs/get-started/ClickHouse.md). ClickHouse backend is developed by [Kyligence](https://kyligence.io/), please visit https://github.com/Kyligence/ClickHouse for more infomation. +For **Velox** backend, please refer to [Velox.md](./docs/get-started/Velox.md) and [build-guide.md](./docs/get-started/build-guide.md). -### 3.2.3 Build options +For **ClickHouse** backend, please refer to [ClickHouse.md](./docs/get-started/ClickHouse.md). ClickHouse backend is developed by [Kyligence](https://kyligence.io/), please visit https://github.com/Kyligence/ClickHouse for more information. -See [Gluten build guide](./docs/get-started/build-guide.md). +Gluten jar will be generated under `/PATH/TO/GLUTEN/package/target/` after build. # 4 Contribution -Welcome to contribute to Gluten project! See [contributing guide](CONTRIBUTING.md) about how to make contributions. +Welcome to contribute to Gluten project! See [CONTRIBUTING.md](CONTRIBUTING.md) about how to make contributions. ## 4.1 Community -Gluten successfully joined Apache Incubator since March'24. We welcome developers and users who are interested in Gluten project. Here are several ways to contact us: +Gluten successfully became Apache incubator project in March'24. We welcome all developers and users who are interested in this project. Here are several ways to contact us: Review Comment: Add the community mail list here: \* For community activity: [email protected] \* For code repository activity: [email protected] -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
