Skip to content

Commit 4c8250c

Browse files
Update README.md
1 parent c8b5550 commit 4c8250c

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
# gbdt-rs
1+
# MesaTEE GBDT-RS
22

33
[![Build Status](https://ci.mesalock-linux.org/api/badges/mesalock-linux/gbdt-rs/status.svg)](https://ci.mesalock-linux.org/mesalock-linux/gbdt-rs)
44
[![codecov](https://codecov.io/gh/mesalock-linux/gbdt-rs/branch/master/graph/badge.svg)](https://codecov.io/gh/mesalock-linux/gbdt-rs)
55

6-
gbdt-rs is a gradient boost decision tree library written in Safe Rust. There is no unsafe rust code in the library.
6+
MesaTEE GBDT-RS is a gradient boost decision tree library written in Safe Rust. There is no unsafe rust code in the library.
77

8-
gbdt-rs provides the training and inference capabilities. And it can use the models trained by [xgboost](https://xgboost.readthedocs.io/en/latest/) to do inference tasks.
8+
MesaTEE GBDT-RS provides the training and inference capabilities. And it can use the models trained by [xgboost](https://xgboost.readthedocs.io/en/latest/) to do inference tasks.
99

10-
New! The gbdt-rs [paper](gbdt.pdf) has been [accepted by IEEE S&P'19](https://www.ieee-security.org/TC/SP2019/program-posters.html)!
10+
New! The MesaTEE GBDT-RS [paper](gbdt.pdf) has been [accepted by IEEE S&P'19](https://www.ieee-security.org/TC/SP2019/program-posters.html)!
1111

1212

1313
# Supported Task
1414
## Supppoted task for both training and inference
1515
1. Linear regression: use SquaredError and LAD loss types
1616
2. Binary classification (labeled with 1 and -1): use LogLikelyhood loss type
1717
## Compatibility with xgboost
18-
At this time, gbdt-rs support to use model trained by xgboost to do inference. The model should be trained by xgboost with following configruation:
18+
At this time, MesaTEE GBDT-RS support to use model trained by xgboost to do inference. The model should be trained by xgboost with following configruation:
1919

2020
1. booster: gbtree
2121
2. objective: "reg:linear", "reg:logistic", "binary:logistic", "binary:logitraw", "multi:softprob", "multi:softmax" or "rank:pairwise".
2222

23-
We have tested that gbdt-rs is compatible with xgboost 0.81 and 0.82
23+
We have tested that MesaTEE GBDT-RS is compatible with xgboost 0.81 and 0.82
2424

2525
# Quick Start
2626
## Training Steps
@@ -84,7 +84,7 @@ We have tested that gbdt-rs is compatible with xgboost 0.81 and 0.82
8484
* Note convert_xgboost.py depends on xgboost python libraries. The converted model can be used on machines without xgboost
8585
3. In rust code, call GBDT::load_from_xgboost(model_path, objective) to load the model
8686
4. Do inference
87-
5. (optional) Call GBDT::save_model to save the model to gbdt-rs native format.
87+
5. (optional) Call GBDT::save_model to save the model to MesaTEE GBDT-RS native format.
8888

8989
## Example code
9090
* "reg:linear": examples/test-xgb-reg-linear.rs
@@ -97,12 +97,12 @@ We have tested that gbdt-rs is compatible with xgboost 0.81 and 0.82
9797

9898
# Multi-threading
9999
## Training:
100-
At this time, training in gbdt-rs is single-threaded.
100+
At this time, training in MesaTEE GBDT-RS is single-threaded.
101101
## Inference:
102102
The related inference functions are single-threaded. But they are thread-safe. We provide an inference example using multi threads in example/test-multithreads.rs
103103

104104
# SGX usage
105-
Because gbdt-rs is written in pure rust, with the help of [rust-sgx-sdk](https://github.com/baidu/rust-sgx-sdk), it can be used in sgx enclave easily as:
105+
Because MesaTEE GBDT-RS is written in pure rust, with the help of [rust-sgx-sdk](https://github.com/baidu/rust-sgx-sdk), it can be used in sgx enclave easily as:
106106

107107
```
108108
gbdt_sgx = { git = "https://github.com/mesalock-linux/gbdt-rs" }

0 commit comments

Comments
 (0)