Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
schmidt73 committed Jun 11, 2024
1 parent 896657a commit 244fe5e
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ The output binary will be located at `build/src/fastbe`.

To run *fastbe*, simply execute the binary.
```
$ fastbe
Usage: fastbe [--help] [--version] {regress,search}
Optional arguments:
Expand Down Expand Up @@ -89,14 +90,14 @@ takes as input an $m \times n$ frequency matrix $F$ and an $n$-clonal
tree $\mathcal{T}$ and outputs the minimum value of
$\lVert F - UB_{\mathcal{T}} \rVert_1$ over all usage matrices $U$.

[!IMPORTANT]
The search command requires a root vertex specified with the
`-f/--assigned-root` flag, corresponding to the appropriate column of the
frequency matrix. By default this root vertex is set to be $0$, or the
first column of the frequency matrix. When the root vertex is unknown,
it suffices to append an extra column to the beginning of the frequency matrix
and specify the root as $0$. As best practice, keep the root vertex
as the first column of the frequency matrix.
> [!IMPORTANT]
> The search command requires a root vertex specified with the
> `-f/--assigned-root` flag, corresponding to the appropriate column of the
> frequency matrix. By default this root vertex is set to be $0$, or the
> first column of the frequency matrix. When the root vertex is unknown,
> it suffices to append an extra column to the beginning of the frequency matrix
> and specify the root as $0$. As best practice, keep the root vertex
> as the first column of the frequency matrix.
### Input format

Expand Down Expand Up @@ -204,5 +205,5 @@ of the search algorithm scales approximately linearly with the beam
width, and the quality of the inferred tree improves with increased
beam width.

[!TIP]
Use the default beam width chosen by `fastbe` for most applications.
> [!TIP]
> Use the default beam width chosen by `fastbe` for most applications.

0 comments on commit 244fe5e

Please sign in to comment.