Skip to content
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.

Sign up for GitHub

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

[2.5] Updated XGBoost User Guide #3109

Merged
merged 2 commits into from
Dec 13, 2024
+11 −10
Merged

[2.5] Updated XGBoost User Guide #3109

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f58b2f
Moved plugin build instructions to prerequisite section
nvidianz Dec 13, 2024
22f18df
Merge branch '2.5' into xgboost-doc-update
nvidianz Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions docs/user_guide/federated_xgboost/secure_xgboost_user_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,15 @@ The following docker image is recommended for GPU training:

nvcr.io/nvidia/pytorch:24.03-py3

Building Encryption Plugins
---------------------------

The secure training requires encryption plugins, which need to be built from the source code
for your specific environment.

To build the plugins, check out the NVFlare source code from https://github.com/NVIDIA/NVFlare and following the
instructions in :github_nvflare_link:`this document. <integration/xgboost/encryption_plugins/README.md>`

.. _xgb_provisioning:

NVFlare Provisioning
Expand Down Expand Up @@ -181,7 +190,7 @@ The plugin can be configured in the ``local/resources.json`` file on clients:
{
"federated_plugin": {
"name": "nvflare",
"path": "/tmp/libnvflare.so"
"path": "/opt/libs/libnvflare.so"
}
}

Expand All @@ -193,7 +202,7 @@ The following environment variables can be used to override the values in the JS
.. code-block:: bash

export NVFLARE_XGB_PLUGIN_NAME=nvflare
export NVFLARE_XGB_PLUGIN_PATH=/tmp/libnvflare.so
export NVFLARE_XGB_PLUGIN_PATH=/opt/libs/libnvflare.so

.. note::

Expand Down Expand Up @@ -222,14 +231,6 @@ For example,

The server_context.tenseal file is not needed.

Building Encryption Plugins
===========================

The plugins need to be built from the source code for your specific environment.

To build the plugins, check out the NVFlare source code from https://github.com/NVIDIA/NVFlare and following the
instructions in :github_nvflare_link:`this document. <integration/xgboost/encryption_plugins/README.md>`

Job Configuration
=================
.. _secure_xgboost_controller:
Expand Down
Loading