Skip to content

Commit

Permalink
[docs] Update LambdaRank example documentation (#2548)
Browse files Browse the repository at this point in the history
- Add reference to documentation on the query data format.
- Refer readers to the official install instructions.
- Change command to use relative path to the `lightgbm` binary built at
the project's root when following build instructions.
  • Loading branch information
malcolmgreaves authored and StrikerRUS committed Nov 22, 2019
1 parent 6a3e27d commit 49df9e6
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions examples/lambdarank/README.md
Expand Up @@ -3,15 +3,16 @@ LambdaRank Example

Here is an example for LightGBM to run lambdarank task.

***You should copy executable file to this folder first.***
***You must follow the [installation instructions](https://lightgbm.readthedocs.io/en/latest/Installation-Guide.html)
for the following commands to work. The `lightgbm` binary must be built and available at the root of this project.***

Training
--------

Run the following command in this folder:

```
"./lightgbm" config=train.conf
```bash
"../../lightgbm" config=train.conf
```

Prediction
Expand All @@ -21,6 +22,13 @@ You should finish training first.

Run the following command in this folder:

```bash
"../../lightgbm" config=predict.conf
```
"./lightgbm" config=predict.conf
```

Data Format
-----------

To learn more about the query format used in this example, check out the
[query data format](https://lightgbm.readthedocs.io/en/latest/Parameters.html#query-data).

0 comments on commit 49df9e6

Please sign in to comment.