Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aoki-h-jp committed Sep 1, 2023
1 parent f3bcc84 commit 465bd1a
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ mapping.liquidation_map_depth_from_historical(
## Examples
### top_n mode
mode="top_n": draw liquidation map from top n trades.

threshold_top_n=100 means draw liquidation map from top 100 large trades.

```python
Expand All @@ -80,7 +81,8 @@ mapping.liquidation_map_depth_from_historical(
![BTCUSDT_2023-08-01_00-00-00-2023-08-01_06-00-00_top_n_100_depth.png](img%2FBTCUSDT_2023-08-01_00-00-00-2023-08-01_06-00-00_top_n_100_depth.png)

### portion mode
mode="portion": draw liquidation map from top n% trades
mode="portion": draw liquidation map from top n% trades.

threshold_portion=0.01 means draw liquidation map from top 1% large trades.

```python
Expand Down

0 comments on commit 465bd1a

Please sign in to comment.