Skip to content

Commit aefbf1d

Browse files
authored
Merge pull request #347 from bashtage/update-changes
DOC: Finalize changes for 4.12 release
2 parents 8ccceb1 + 8497f5c commit aefbf1d

File tree

2 files changed

+89
-85
lines changed

2 files changed

+89
-85
lines changed

README.md

+80-80
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,31 @@ Autoregressive Conditional Heteroskedasticity (ARCH) and other tools for
66
financial econometrics, written in Python (with Cython and/or Numba used
77
to improve performance)
88

9-
| | |
10-
| :-------- | :------------- |
11-
| **Latest Release** | [![PyPI version](https://badge.fury.io/py/arch.svg)](https://badge.fury.io/py/arch) |
12-
| | [![Anaconda-Server Badge](https://anaconda.org/bashtage/arch/badges/version.svg)](https://anaconda.org/bashtage/arch) |
13-
| **Continuous Integration** | [![Travis Build Status](https://travis-ci.org/bashtage/arch.svg?branch=master)](https://travis-ci.org/bashtage/arch) |
14-
| | [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/nmt02u7jwcgx7i2x?svg=true)](https://ci.appveyor.com/project/bashtage/arch/branch/master) |
15-
| **Coverage** | [![Coverage Status](https://coveralls.io/repos/github/bashtage/arch/badge.svg?branch=master)](https://coveralls.io/r/bashtage/arch?branch=master) |
16-
| | [![codecov](https://codecov.io/gh/bashtage/arch/branch/master/graph/badge.svg)](https://codecov.io/gh/bashtage/arch) |
17-
| **Code Quality** | [![Code Quality: Python](https://img.shields.io/lgtm/grade/python/g/bashtage/arch.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/bashtage/arch/context:python) |
18-
| | [![Total Alerts](https://img.shields.io/lgtm/alerts/g/bashtage/arch.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/bashtage/arch/alerts) |
19-
| | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/93f6fd90209842bf97fd20fda8db70ef)](https://www.codacy.com/manual/bashtage/arch?utm_source=github.com&utm_medium=referral&utm_content=bashtage/arch&utm_campaign=Badge_Grade) |
20-
| | [![codebeat badge](https://codebeat.co/badges/18a78c15-d74b-4820-b56d-72f7e4087532)](https://codebeat.co/projects/github-com-bashtage-arch-master) |
21-
| **Citation** | [![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.3551028.svg)](https://doi.org/10.5281/zenodo.3551028) |
22-
| **Documentation** | [![Documentation Status](https://readthedocs.org/projects/arch/badge/?version=latest)](http://arch.readthedocs.org/en/latest/) |
9+
| Metric | |
10+
| :------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11+
| **Latest Release** | [![PyPI version](https://badge.fury.io/py/arch.svg)](https://badge.fury.io/py/arch) |
12+
| | [![Anaconda-Server Badge](https://anaconda.org/bashtage/arch/badges/version.svg)](https://anaconda.org/bashtage/arch) |
13+
| **Continuous Integration** | [![Travis Build Status](https://travis-ci.org/bashtage/arch.svg?branch=master)](https://travis-ci.org/bashtage/arch) |
14+
| | [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/nmt02u7jwcgx7i2x?svg=true)](https://ci.appveyor.com/project/bashtage/arch/branch/master) |
15+
| **Coverage** | [![Coverage Status](https://coveralls.io/repos/github/bashtage/arch/badge.svg?branch=master)](https://coveralls.io/r/bashtage/arch?branch=master) |
16+
| | [![codecov](https://codecov.io/gh/bashtage/arch/branch/master/graph/badge.svg)](https://codecov.io/gh/bashtage/arch) |
17+
| **Code Quality** | [![Code Quality: Python](https://img.shields.io/lgtm/grade/python/g/bashtage/arch.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/bashtage/arch/context:python) |
18+
| | [![Total Alerts](https://img.shields.io/lgtm/alerts/g/bashtage/arch.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/bashtage/arch/alerts) |
19+
| | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/93f6fd90209842bf97fd20fda8db70ef)](https://www.codacy.com/manual/bashtage/arch?utm_source=github.com&utm_medium=referral&utm_content=bashtage/arch&utm_campaign=Badge_Grade) |
20+
| | [![codebeat badge](https://codebeat.co/badges/18a78c15-d74b-4820-b56d-72f7e4087532)](https://codebeat.co/projects/github-com-bashtage-arch-master) |
21+
| **Citation** | [![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.3551028.svg)](https://doi.org/10.5281/zenodo.3551028) |
22+
| **Documentation** | [![Documentation Status](https://readthedocs.org/projects/arch/badge/?version=latest)](http://arch.readthedocs.org/en/latest/) |
2323

2424
## Module Contents
2525

26-
* [Univariate ARCH Models](#volatility)
27-
* [Unit Root Tests](#unit-root)
28-
* [Bootstrapping](#bootstrap)
29-
* [Multiple Comparison Tests](#multiple-comparison)
26+
- [Univariate ARCH Models](#volatility)
27+
- [Unit Root Tests](#unit-root)
28+
- [Bootstrapping](#bootstrap)
29+
- [Multiple Comparison Tests](#multiple-comparison)
3030

3131
### Python 3
3232

33-
``arch`` is Python 3 only. Version 4.8 is the final version that supported Python 2.7.
33+
`arch` is Python 3 only. Version 4.8 is the final version that supported Python 2.7.
3434

3535
## Documentation
3636

@@ -46,34 +46,34 @@ research available at [Kevin Sheppard's site](http://www.kevinsheppard.com).
4646

4747
## Contributing
4848

49-
Contributions are welcome. There are opportunities at many levels to contribute:
49+
Contributions are welcome. There are opportunities at many levels to contribute:
5050

51-
* Implement new volatility process, e.g., FIGARCH
52-
* Improve docstrings where unclear or with typos
53-
* Provide examples, preferably in the form of IPython notebooks
51+
- Implement new volatility process, e.g., FIGARCH
52+
- Improve docstrings where unclear or with typos
53+
- Provide examples, preferably in the form of IPython notebooks
5454

5555
## Examples
5656

5757
<a id="volatility"></a>
5858

5959
### Volatility Modeling
6060

61-
* Mean models
62-
* Constant mean
63-
* Heterogeneous Autoregression (HAR)
64-
* Autoregression (AR)
65-
* Zero mean
66-
* Models with and without exogenous regressors
67-
* Volatility models
68-
* ARCH
69-
* GARCH
70-
* TARCH
71-
* EGARCH
72-
* EWMA/RiskMetrics
73-
* Distributions
74-
* Normal
75-
* Student's T
76-
* Generalized Error Distribution
61+
- Mean models
62+
- Constant mean
63+
- Heterogeneous Autoregression (HAR)
64+
- Autoregression (AR)
65+
- Zero mean
66+
- Models with and without exogenous regressors
67+
- Volatility models
68+
- ARCH
69+
- GARCH
70+
- TARCH
71+
- EGARCH
72+
- EWMA/RiskMetrics
73+
- Distributions
74+
- Normal
75+
- Student's T
76+
- Generalized Error Distribution
7777

7878
See the [univariate volatility example notebook](http://nbviewer.ipython.org/github/bashtage/arch/blob/master/examples/univariate_volatility_modeling.ipynb) for a more complete overview.
7979

@@ -94,31 +94,31 @@ res = am.fit()
9494

9595
### Unit Root Tests
9696

97-
* Augmented Dickey-Fuller
98-
* Dickey-Fuller GLS
99-
* Phillips-Perron
100-
* KPSS
101-
* Zivot-Andrews
102-
* Variance Ratio tests
97+
- Augmented Dickey-Fuller
98+
- Dickey-Fuller GLS
99+
- Phillips-Perron
100+
- KPSS
101+
- Zivot-Andrews
102+
- Variance Ratio tests
103103

104104
See the [unit root testing example notebook](http://nbviewer.ipython.org/github/bashtage/arch/blob/master/examples/unitroot_examples.ipynb) for examples of testing series for unit roots.
105105

106106
<a id="bootstrap"></a>
107107

108108
### Bootstrap
109109

110-
* Bootstraps
111-
* IID Bootstrap
112-
* Stationary Bootstrap
113-
* Circular Block Bootstrap
114-
* Moving Block Bootstrap
115-
* Methods
116-
* Confidence interval construction
117-
* Covariance estimation
118-
* Apply method to estimate model across bootstraps
119-
* Generic Bootstrap iterator
120-
121-
See the [bootstrap example notebook](http://nbviewer.ipython.org/github/bashtage/arch/blob/master/examples/bootstrap_examples.ipynb)
110+
- Bootstraps
111+
- IID Bootstrap
112+
- Stationary Bootstrap
113+
- Circular Block Bootstrap
114+
- Moving Block Bootstrap
115+
- Methods
116+
- Confidence interval construction
117+
- Covariance estimation
118+
- Apply method to estimate model across bootstraps
119+
- Generic Bootstrap iterator
120+
121+
See the [bootstrap example notebook](http://nbviewer.ipython.org/github/bashtage/arch/blob/master/examples/bootstrap_examples.ipynb)
122122
for examples of bootstrapping the Sharpe ratio and a Probit model from statsmodels.
123123

124124
```python
@@ -151,37 +151,37 @@ ci = bs.conf_int(sharpe_ratio, 1000, method='percentile')
151151

152152
### Multiple Comparison Procedures
153153

154-
* Test of Superior Predictive Ability (SPA), also known as the Reality
155-
Check or Bootstrap Data Snooper
156-
* Stepwise (StepM)
157-
* Model Confidence Set (MCS)
154+
- Test of Superior Predictive Ability (SPA), also known as the Reality
155+
Check or Bootstrap Data Snooper
156+
- Stepwise (StepM)
157+
- Model Confidence Set (MCS)
158158

159159
See the [multiple comparison example notebook](http://nbviewer.ipython.org/github/bashtage/arch/blob/master/examples/multiple-comparison_examples.ipynb)
160160
for examples of the multiple comparison procedures.
161161

162162
## Requirements
163163

164-
These requirements reflect the testing environment. It is possible
164+
These requirements reflect the testing environment. It is possible
165165
that arch will work with older versions.
166166

167-
* Python (3.6+)
168-
* NumPy (1.14+)
169-
* SciPy (1.0.1+)
170-
* Pandas (0.23+)
171-
* statsmodels (0.9+)
172-
* matplotlib (2.0+), optional
173-
* property-cached (1.6.3+), optional
167+
- Python (3.6+)
168+
- NumPy (1.14+)
169+
- SciPy (1.0.1+)
170+
- Pandas (0.23+)
171+
- statsmodels (0.9+)
172+
- matplotlib (2.0+), optional
173+
- property-cached (1.6.3+), optional
174174

175175
### Optional Requirements
176176

177-
* Numba (0.35+) will be used if available **and** when installed using the --no-binary option
178-
* jupyter and notebook are required to run the notebooks
177+
- Numba (0.35+) will be used if available **and** when installed using the --no-binary option
178+
- jupyter and notebook are required to run the notebooks
179179

180180
## Installing
181181

182182
Standard installation with a compiler requires Cython. If you do not
183183
have a compiler installed, the `arch` should still install. You will
184-
see a warning but this can be ignored. If you don't have a compiler,
184+
see a warning but this can be ignored. If you don't have a compiler,
185185
`numba` is strongly recommended.
186186

187187
### pip
@@ -219,24 +219,24 @@ conda install arch -c bashtage
219219
### Windows
220220

221221
Building extension using the community edition of Visual Studio is
222-
well supported for Python 3.6+. Building on other combinations of
223-
Python/Windows is more difficult and is not necessary when numba
222+
well supported for Python 3.6+. Building on other combinations of
223+
Python/Windows is more difficult and is not necessary when numba
224224
is installed since just-in-time compiled code (numba) runs as fast as
225225
ahead-of-time compiled extensions.
226226

227227
### Developing
228228

229229
The development requirements are:
230230

231-
* Cython (0.29+, if not using --no-binary)
232-
* pytest (For tests)
233-
* sphinx (to build docs)
234-
* sphinx_material (to build docs)
235-
* jupyter, notebook and nbsphinx (to build docs)
231+
- Cython (0.29+, if not using --no-binary)
232+
- pytest (For tests)
233+
- sphinx (to build docs)
234+
- sphinx_material (to build docs)
235+
- jupyter, notebook and nbsphinx (to build docs)
236236

237237
### Installation Notes
238238

239239
1. If Cython is not installed, the package will be installed
240240
as-if `--no-binary` was used.
241-
2. Setup does not verify these requirements. Please ensure these are
241+
2. Setup does not verify these requirements. Please ensure these are
242242
installed.

doc/source/changes/4.0.txt

+9-5
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22
Version 4
33
=========
44

5-
Since 4.11
6-
==========
5+
Release 4.12
6+
============
7+
- Added typing support to all classes, functions and methods (:issue:`338`,
8+
:issue:`341`, :issue:`342`, :issue:`343`, :issue:`345`, :issue:`346`).
9+
- Fixed an issue that caused tests to fail on SciPy 1.4+ (:issue:`339`).
710
- Dropped support for Python 3.5 inline with NEP 29 (:issue:`334`).
8-
- Added methods to compute moment and lower partial moments for standardized residuals. See,
9-
for example, :func:`~arch.univariate.SkewStudent.moment` and
11+
- Added methods to compute moment and lower partial moments for standardized
12+
residuals. See, for example, :func:`~arch.univariate.SkewStudent.moment` and
1013
:func:`~arch.univariate.SkewStudent.partial_moment` (:issue:`329`).
11-
- Fixed a bug that produced an OverflowError when a time series has no variance (:issue:`331`).
14+
- Fixed a bug that produced an OverflowError when a time series has no
15+
variance (:issue:`331`).
1216

1317
Release 4.11
1418
============

0 commit comments

Comments
 (0)