Skip to content

Commit bac676c

Browse files
committed
Update documentations
1 parent 15b1018 commit bac676c

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

docs/api.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This section provides detailed API documentation for the tailestim package.
88

99
base
1010
estimators/index
11+
estimator-set
1112
result
1213
data
1314

docs/estimator-set.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Estimator Set
2+
=============
3+
4+
.. automodule:: tailestim.estimators.estimator_set
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Examples
10+
--------
11+
12+
.. code-block:: python
13+
14+
from tailestim import TailData, TailEstimatorSet
15+
import matplotlib.pyplot as plt
16+
17+
data = TailData(name='CAIDA_KONECT').data
18+
19+
estim_set = TailEstimatorSet()
20+
estim_set.fit(data)
21+
22+
estim_set.plot()
23+
plt.show()
24+
25+
estim_set.plot_diagnostics()
26+
plt.show()

0 commit comments

Comments
 (0)