Merge pull request #28 from mu373/plot-functions

Add plot functions

Author: mu373

docs/api.rst

@@ -8,6 +8,7 @@ This section provides detailed API documentation for the tailestim package.
 
    base
    estimators/index
+   estimator-set
    result
    data
 

docs/estimator-set.rst

@@ -0,0 +1,26 @@
+Estimator Set
+=============
+
+.. automodule:: tailestim.estimators.estimator_set
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Examples
+--------
+
+.. code-block:: python
+
+   from tailestim import TailData, TailEstimatorSet
+   import matplotlib.pyplot as plt
+
+   data = TailData(name='CAIDA_KONECT').data
+
+   estim_set = TailEstimatorSet()
+   estim_set.fit(data)
+
+   estim_set.plot()
+   plt.show()
+
+   estim_set.plot_diagnostics()
+   plt.show()

examples/example.ipynb

@@ -1,6 +1,9 @@
 from tailestim import TailData
 from tailestim import HillEstimator, KernelTypeEstimator, MomentsEstimator
 
+from tailestim import TailEstimatorSet
+import matplotlib.pyplot as plt
+
 # Load a built-in dataset
 data = TailData(name='CAIDA_KONECT').data
 
@@ -19,4 +22,13 @@
 gamma = result.gamma
 
 # Print full results
-print(result)
+print(result)
+
+# Compare multiple estimators and plot results
+estim_set = TailEstimatorSet.fit(data)
+estim_set.plot()
+plt.show()
+
+# You can also plot diagnostic plots
+estim_set.plot_diagnostics()
+plt.show()

examples/example.py

@@ -24,7 +24,8 @@ classifiers = [
   "Programming Language :: Python :: 3.13",
 ]
 dependencies = [
-  "numpy>=1.19"
+  "numpy>=1.19",
+  "matplotlib>=3.5"
 ]
 
 [project.urls]

pyproject.toml

@@ -2,20 +2,24 @@
 #
 # SPDX-License-Identifier: MIT
 
+from .datasets import TailData
+
 from .estimators.base import BaseTailEstimator
 from .estimators.hill import HillEstimator
 from .estimators.moments import MomentsEstimator
 from .estimators.kernel import KernelTypeEstimator
 from .estimators.pickands import PickandsEstimator
 from .estimators.smooth_hill import SmoothHillEstimator
-from .datasets import TailData
+
+from .estimators.estimator_set import TailEstimatorSet
 
 __all__ = [
+    'TailData',
     'BaseTailEstimator',
     'HillEstimator',
     'MomentsEstimator',
     'KernelTypeEstimator',
     'PickandsEstimator',
     'SmoothHillEstimator',
-    'TailData',
+    'TailEstimatorSet',
 ]

src/tailestim/__init__.py

@@ -0,0 +1,19 @@
+"""Estimators for tail index estimation."""
+
+from .base import BaseTailEstimator
+from .hill import HillEstimator
+from .moments import MomentsEstimator
+from .kernel import KernelTypeEstimator
+from .pickands import PickandsEstimator
+from .smooth_hill import SmoothHillEstimator
+from .estimator_set import TailEstimatorSet
+
+__all__ = [
+    'BaseTailEstimator',
+    'HillEstimator',
+    'MomentsEstimator',
+    'KernelTypeEstimator',
+    'PickandsEstimator',
+    'SmoothHillEstimator',
+    'TailEstimatorSet',
+]