[Doc] add doc for kill_spark_context_on_worker_failure parameter #6097
Conversation
This file contains 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
hcho3
approved these changes
Sep 9, 2020
hcho3
requested changes
Sep 9, 2020
doc/jvm/xgboost4j_spark_tutorial.rst
Outdated
|
|
||
| **SparkContext will be stopped by default when XGBoost training task fails**. | ||
|
|
||
| To address this issue, we added a parameter **kill_spark_context_on_worker_failure** in `#6019 <https://github.com/dmlc/xgboost/pull/6019>`_ from **XGBoost4j-Spark 1.2.0**. When **kill_spark_context_on_worker_failure** is set to **false**, the SparkContext will not be stopped even XGBoost training task fails, instead, we throw out the exception. So for the users who want to continue using SparkContext should **try catch** the training code. |
There was a problem hiding this comment.
Suggested change
| To address this issue, we added a parameter **kill_spark_context_on_worker_failure** in `#6019 <https://github.com/dmlc/xgboost/pull/6019>`_ from **XGBoost4j-Spark 1.2.0**. When **kill_spark_context_on_worker_failure** is set to **false**, the SparkContext will not be stopped even XGBoost training task fails, instead, we throw out the exception. So for the users who want to continue using SparkContext should **try catch** the training code. | |
| XGBoost4J-Spark 1.2.0+ exposes a parameter **kill_spark_context_on_worker_failure**. Set **kill_spark_context_on_worker_failure** to **false** so that the SparkContext will not be stopping on training failure. Instead of stopping the SparkContext, XGBoost4J-Spark will throw an exception instead. Users who want to re-use the SparkContext should wrap the training code in a try-catch block. |
hcho3
approved these changes
Sep 9, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
doc for kill_spark_context_on_worker_failure