mc2-project / mc2-project/secure-xgboost
Documentation improvements
Open
Nobody has claimed this yet.
documentation
- Dominant language
- C++
- Stars
- 108
- Forks
- 31
- PR merge metrics
- No merged PRs in 30d
Description
Starting this thread to track and collect various documentation improvements.
- Document initialization APIs for client and enclave, and explain the various client / enclave keys
- Add config file description for
init_clientAPI; add it to the demos as well - Consensus v. non-consensus mode, and which APIs require consensus
- Clarify that obliviousness only supported for
histtraining at present - Text input format; e.g. https://xgboost.readthedocs.io/en/latest/tutorials/input_format.html
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the initialization APIs, the init_client configuration and demos, consensus and non-consensus API guidance, oblivious hist training documentation, and the text input format. Done means each checklist item is documented clearly, with the init_client configuration also covered in the demos.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, machine-learning, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100