Skip to content

Commit

Permalink
replaces the algorithms Venn diagram with a table in the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
@j-bryan
j-bryan committed Jul 6, 2023
1 parent 50c63c1 commit b7d80db
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
Binary file removed ravenframework/TSA/AlgorithmClassification.png
View file
Binary file not shown.
22 changes: 20 additions & 2 deletions ravenframework/TSA/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,23 @@ Specifically, the purpose of these transformers is not to generate a new time se
The `TimeSeriesTransformer` class is also responsible for computing model residuals during the fitting process and combining one or more signals into a single signal during the generation process.

## TSA Algorithm Inheritance
The following diagram shows which base classes each currently implemented TSA algorithm inherits from.
![Venn diagram of TSA algorithm inheritance](AlgorithmClassification.png)
The following table shows which base classes each currently implemented TSA algorithm inherits from.

| Algorithm | Transformer | Generator | Characterizer |
|------------------------|:-----------:|:---------:|:-------------:|
| `ARMA` | ✓ | ✓ | ✓ |
| `Fourier` | ✓ | ✓ | ✓ |
| `PolynomialRegression` | ✓ | ✓ | ✓ |
| `RWD` | | | ✓ |
| `Wavelet` | ✓ | ✓ | |
| `OutTruncation` | ✓ | | |
| `ZeroFilter` | ✓ | | |
| `MaxAbsScaler` | ✓ | | ✓ |
| `MinMaxScaler` | ✓ | | ✓ |
| `StandardScaler` | ✓ | | ✓ |
| `RobustScaler` | ✓ | | ✓ |
| `LogTransformer` | ✓ | | |
| `ArcsinhTransformer` | ✓ | | |
| `TanhTransformer` | ✓ | | |
| `SigmoidTransformer` | ✓ | | |
| `QuantileTransformer` | ✓ | | |

0 comments on commit b7d80db

Please sign in to comment.