Skip to content

Commit 3ea39ae

Browse files
committed
Update README
1 parent 2302938 commit 3ea39ae

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[paper_website]: https://www.newyorkfed.org/medialibrary/media/research/staff_reports/sr340.pdf
22
[inference_atribute]: https://github.com/gusamarante/pyacm/blob/ba641c14e450fc83d22db4ef5e60eadbd489b351/pyacm/acm.py#L203
3-
**Still under development...**
3+
4+
**<span style="color:red">STILL UNDER DEVELOPMENT</span>**
45

56
# pyacm
67
Implementation of ["Pricing the Term Structure with Linear Regressions" from
@@ -9,14 +10,28 @@ Adrian, Crump and Moench (2013)][paper_website].
910
The `NominalACM` class prices the time series and cross-section of the term
1011
structure of interest rates using a three-step linear regression approach.
1112
Computations are fast, even with a large number of pricing factors. The object
12-
carries all the relevant measures as atributes:
13-
- SOON...
13+
carries all the relevant variables as atributes:
14+
- The yield curve itself
15+
- The excess returns from the synthetic zero coupon bonds
16+
- The principal components of the curve used as princing factors
17+
- Risk premium parameter estimates
18+
- Yields fitted by the model
19+
- Risk-neutral yields
20+
- Term premium
21+
- Expected return loadings
22+
- Hypothesis testing (Not sure if correct, more info observations below)
23+
24+
25+
# Instalation
26+
```bash
27+
pip install pyacm
28+
```
1429

1530
# Example
1631
SOON...
1732

1833

19-
### Observations
34+
# Observations
2035
I am not completely sure that computations in the [inferences attributes]
2136
[inference_atribute] are correct. If you find any mistakes, please open a pull
2237
request following the contributing guidelines.

0 commit comments

Comments
 (0)