Skip to content

Commit

Permalink
doc: syntax highlighting
Browse files Browse the repository at this point in the history
  • Loading branch information
mchitre committed Nov 15, 2024
1 parent 64d43c7 commit ffa4d9c
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pkg> add AdaptiveEstimators
## API

Currently, the public API consists of only the following:
```
```julia
# fit model to data (x, y) using specified algorithm
fit!(model::SystemModel, alg::Estimator, x, y; saveat, rng)
fit!(model::SystemModel, alg::Estimator, x, y, nsteps, decision; ...)
Expand All @@ -47,9 +47,7 @@ See docstrings (`help fit!`, etc) for details.

### Channel estimation
Consider a linear system:
$$
y_n = \sum_{i=0}^{N-1} h_i^* x_{n-i} + \text{noise}.
$$
$$y_n = \sum_{i=0}^{N-1} h_i^* x_{n-i} + \text{noise}.$$
Here, $\{x_n\}$ may be a transmitted communication signal, and $\{y_n\}$ the received signal after passing through a channel with an impulse response $\{h_i\}$. Let us first consider a channel estimation application where we transmit a known baseband complex signal $\{x_n\}$, observe the received baseband complex signal $\{y_n\}$, and wish to estimate $\{h_i\}$:
```julia
using AdaptiveEstimators
Expand Down

0 comments on commit ffa4d9c

Please sign in to comment.