diff --git a/.gitignore b/.gitignore index c5a75803..4d13d785 100644 --- a/.gitignore +++ b/.gitignore @@ -69,6 +69,7 @@ instance/ docs/_build/ docs/auto_examples/ docs/modules/generated/ +docs/library/generated/ # PyBuilder target/ diff --git a/chainladder/core/pandas.py b/chainladder/core/pandas.py index 7e62b9c0..a4f75d48 100644 --- a/chainladder/core/pandas.py +++ b/chainladder/core/pandas.py @@ -72,6 +72,7 @@ def to_frame( **kwargs ) -> DataFrame | Series: """ Converts a triangle to a pandas.DataFrame. + Parameters ---------- origin_as_datetime : bool @@ -84,9 +85,10 @@ def to_frame( implicit_axis : bool When keepdims is True, this denotes whether to include the implicit valuation axis in addition to the origin and development. + Returns ------- - DataFrame or Series representation of the Triangle. + DataFrame or Series representation of the Triangle. """ # Identify the axes that increase the dimensionality of the triangle, i.e., those whose length is > 1. @@ -204,7 +206,7 @@ def _get_axis(axis: str | int| None) -> int: supplied as a string, returns the integer representation. If supplied as an integer, returns the same integer. - Returns` + Returns ------- The integer representation of the requested axis @@ -252,6 +254,7 @@ def dropna(self): def fillna(self, value=None, inplace=False): """Fill nan with 'value' by axis. + Parameters ---------- value: single value or array-like values, default = None @@ -277,6 +280,7 @@ def fillna(self, value=None, inplace=False): def fillzero(self, inplace=False): """Fill nan with 0 by axis. separate function from fillna() because fillna(0) isn't working + Parameters ---------- inplace: boolean, default = False @@ -457,9 +461,11 @@ def xs( level:IndexLabel | None = None, drop_level:bool = True): ''' - mimics xs from pandas. key difference - - this function only slides the index, therefore axis is always 0 and not an argument in the function - main use case for this function is when slicing beyond the first field in the index (such as LOB in the clrd dataset) + Mimics xs from pandas. key difference is that this function only slices + the index, therefore axis is always 0 and not an argument in the function + + Main use case for this function is when slicing beyond the first field in + the index (such as LOB in the clrd dataset) ''' mi = pd.MultiIndex.from_frame(self.index) diff --git a/chainladder/development/incremental.py b/chainladder/development/incremental.py index fb0537e0..39747353 100644 --- a/chainladder/development/incremental.py +++ b/chainladder/development/incremental.py @@ -62,7 +62,7 @@ class IncrementalAdditive(DevelopmentBase): w_: ndarray The weight used in the zeta fitting w_tri_: Triangle - Triangle of w_ + Triangle of w\_ sample_weight: Triangle The exposure used to obtain incremental factor incremental_: Triangle diff --git a/chainladder/methods/capecod.py b/chainladder/methods/capecod.py index 0d132d82..03139b81 100644 --- a/chainladder/methods/capecod.py +++ b/chainladder/methods/capecod.py @@ -18,11 +18,11 @@ class CapeCod(Benktander): decay: float, optional (default=1.0) The cape cod decay assumption. This parameter is required by the Generalized Cape Cod Method, as discussed in [Using Best Practices to - Determine a Best Reserve Estimate](https://www.casact.org/sites/default/files/database/forum_98fforum_struhuss.pdf) - by Struzzieri and Hussian. As the `decay` factor approaches 1 - (the default value), the result approaches the traditional Cape Cod - method. As the `decay` factor approaches 0, the result approaches - the `Chainladder` method. + Determine a Best Reserve Estimate](https://www.casact.org/sites/default/files/database/forum_98fforum_struhuss.pdf) + by Struzzieri and Hussian. As the `decay` factor approaches 1 + (the default value), the result approaches the traditional Cape Cod + method. As the `decay` factor approaches 0, the result approaches + the `Chainladder` method. n_iters: int, optional (default=1) Number of iterations to use in the Benktander model. groupby: str or list, optional (default=None) diff --git a/docs/_config.yml b/docs/_config.yml index 4dccd8ab..4f971481 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -43,6 +43,8 @@ sphinx: linkcode: _ext config: autosummary_generate: True + templates_path: ['_templates'] + numpydoc_show_class_members: False bibtex_reference_style: author_year parse: diff --git a/docs/_ext/linkcode.py b/docs/_ext/linkcode.py index 6ec36560..15f687fa 100644 --- a/docs/_ext/linkcode.py +++ b/docs/_ext/linkcode.py @@ -49,15 +49,30 @@ def linkcode_resolve(domain: str, info: dict) -> str | None: mod: ModuleType = importlib.import_module(info["module"]) obj: ModuleType = mod - # Extract the part. + # Extract the part. Some documented members (e.g. instance attributes pulled + # in via :inherited-members:) are not accessible on the object itself; skip + # linking those rather than crashing the build. for part in info["fullname"].split("."): - obj: type = getattr(obj, part) + try: + obj: type = getattr(obj, part) + except AttributeError: + return None + + # Resolve properties to their underlying getter function. + if isinstance(obj, property): + obj = obj.fget + if obj is None: + return None # Unwrap any decorators. obj: type = inspect.unwrap(obj) - # Get the path of the source file. - source_file: str = inspect.getsourcefile(obj) + # Get the path of the source file. Some objects (e.g. C-level callables or + # dynamically created members) are not introspectable; skip linking those. + try: + source_file: str = inspect.getsourcefile(obj) + except TypeError: + return None # If the source file cannot be found, return the URL pointing to a .py file named after the module. if source_file is None: @@ -65,7 +80,11 @@ def linkcode_resolve(domain: str, info: dict) -> str | None: return url_base + "%s.py" % filename # Extract the lines and locate the starting line position. - source_lines, start_line = inspect.getsourcelines(obj) + try: + source_lines, start_line = inspect.getsourcelines(obj) + except (TypeError, OSError): + filename: str = info["module"].replace(".", "/") + return url_base + "%s.py" % filename # Get the root path. root_path: str = os.path.abspath(os.path.join(cl.__file__, "..", "..")) diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst new file mode 100644 index 00000000..bbe4b58e --- /dev/null +++ b/docs/_templates/autosummary/class.rst @@ -0,0 +1,26 @@ +{{ objname | escape | underline }} + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + :members: + :undoc-members: + :exclude-members: set_fit_request, set_score_request, set_transform_request, {{ attributes | join(', ') }} + +{% set inherited = [] %} +{% for method in methods %} +{% if method in inherited_members and not method.startswith('_') %} +{% set _ = inherited.append(method) %} +{% endif %} +{% endfor %} + +{% if inherited %} +.. rubric:: Inherited Methods + +.. autosummary:: + :nosignatures: + +{% for method in inherited %} + {{ objname }}.{{ method }} +{% endfor %} +{% endif %} diff --git a/docs/_templates/autosummary/class_inherited.rst b/docs/_templates/autosummary/class_inherited.rst new file mode 100644 index 00000000..bbe4b58e --- /dev/null +++ b/docs/_templates/autosummary/class_inherited.rst @@ -0,0 +1,26 @@ +{{ objname | escape | underline }} + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + :members: + :undoc-members: + :exclude-members: set_fit_request, set_score_request, set_transform_request, {{ attributes | join(', ') }} + +{% set inherited = [] %} +{% for method in methods %} +{% if method in inherited_members and not method.startswith('_') %} +{% set _ = inherited.append(method) %} +{% endif %} +{% endfor %} + +{% if inherited %} +.. rubric:: Inherited Methods + +.. autosummary:: + :nosignatures: + +{% for method in inherited %} + {{ objname }}.{{ method }} +{% endfor %} +{% endif %} diff --git a/docs/_templates/autosummary/function.rst b/docs/_templates/autosummary/function.rst new file mode 100644 index 00000000..27ca987d --- /dev/null +++ b/docs/_templates/autosummary/function.rst @@ -0,0 +1,5 @@ +{{ fullname | escape | underline }} + +.. currentmodule:: {{ module }} + +.. autofunction:: {{ objname }} diff --git a/docs/conf.py b/docs/conf.py index 40e4f4a7..07167688 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,5 +40,7 @@ numfig = True pygments_style = 'sphinx' suppress_warnings = ['myst.domains'] +templates_path = ['_templates'] +numpydoc_show_class_members = False use_jupyterbook_latex = True use_multitoc_numbering = True diff --git a/docs/library/api.md b/docs/library/api.md index d0985fab..ed0b66e0 100644 --- a/docs/library/api.md +++ b/docs/library/api.md @@ -20,7 +20,7 @@ Classes .. autosummary:: :toctree: generated/ - :template: class_inherited.rst + :template: class_inherited Triangle DevelopmentCorrelation @@ -43,7 +43,7 @@ Classes .. autosummary:: :toctree: generated/ - :template: class.rst + :template: class Development DevelopmentConstant @@ -72,7 +72,7 @@ Classes .. autosummary:: :toctree: generated/ - :template: class.rst + :template: class TailConstant TailCurve @@ -96,7 +96,7 @@ Classes .. autosummary:: :toctree: generated/ - :template: class.rst + :template: class Chainladder MackChainladder @@ -119,7 +119,7 @@ Classes .. autosummary:: :toctree: generated/ - :template: class.rst + :template: class BootstrapODPSample BerquistSherman @@ -140,7 +140,7 @@ Classes .. autosummary:: :toctree: generated/ - :template: class.rst + :template: class Pipeline VotingChainladder @@ -162,7 +162,7 @@ Functions .. autosummary:: :toctree: generated/ - :template: function.rst + :template: function load_sample read_pickle @@ -178,8 +178,8 @@ Classes .. autosummary:: :toctree: generated/ - :template: class.rst + :template: class PatsyFormula -``` \ No newline at end of file +``` diff --git a/docs/library/generated/chainladder.BarnettZehnwirth.rst b/docs/library/generated/chainladder.BarnettZehnwirth.rst deleted file mode 100644 index 7f5b6599..00000000 --- a/docs/library/generated/chainladder.BarnettZehnwirth.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.BarnettZehnwirth -============================ - -.. currentmodule:: chainladder - -.. autoclass:: BarnettZehnwirth \ No newline at end of file diff --git a/docs/library/generated/chainladder.Benktander.rst b/docs/library/generated/chainladder.Benktander.rst deleted file mode 100644 index ac68cb79..00000000 --- a/docs/library/generated/chainladder.Benktander.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.Benktander -====================== - -.. currentmodule:: chainladder - -.. autoclass:: Benktander \ No newline at end of file diff --git a/docs/library/generated/chainladder.BerquistSherman.rst b/docs/library/generated/chainladder.BerquistSherman.rst deleted file mode 100644 index 99464424..00000000 --- a/docs/library/generated/chainladder.BerquistSherman.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.BerquistSherman -=========================== - -.. currentmodule:: chainladder - -.. autoclass:: BerquistSherman \ No newline at end of file diff --git a/docs/library/generated/chainladder.BootstrapODPSample.rst b/docs/library/generated/chainladder.BootstrapODPSample.rst deleted file mode 100644 index fc9529ef..00000000 --- a/docs/library/generated/chainladder.BootstrapODPSample.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.BootstrapODPSample -============================== - -.. currentmodule:: chainladder - -.. autoclass:: BootstrapODPSample \ No newline at end of file diff --git a/docs/library/generated/chainladder.BornhuetterFerguson.rst b/docs/library/generated/chainladder.BornhuetterFerguson.rst deleted file mode 100644 index d2ccbbc8..00000000 --- a/docs/library/generated/chainladder.BornhuetterFerguson.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.BornhuetterFerguson -=============================== - -.. currentmodule:: chainladder - -.. autoclass:: BornhuetterFerguson \ No newline at end of file diff --git a/docs/library/generated/chainladder.CapeCod.rst b/docs/library/generated/chainladder.CapeCod.rst deleted file mode 100644 index bdcc0539..00000000 --- a/docs/library/generated/chainladder.CapeCod.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.CapeCod -=================== - -.. currentmodule:: chainladder - -.. autoclass:: CapeCod \ No newline at end of file diff --git a/docs/library/generated/chainladder.CaseOutstanding.rst b/docs/library/generated/chainladder.CaseOutstanding.rst deleted file mode 100644 index 1797b98e..00000000 --- a/docs/library/generated/chainladder.CaseOutstanding.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.CaseOutstanding -=========================== - -.. currentmodule:: chainladder - -.. autoclass:: CaseOutstanding \ No newline at end of file diff --git a/docs/library/generated/chainladder.Chainladder.rst b/docs/library/generated/chainladder.Chainladder.rst deleted file mode 100644 index e2956836..00000000 --- a/docs/library/generated/chainladder.Chainladder.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.Chainladder -======================= - -.. currentmodule:: chainladder - -.. autoclass:: Chainladder \ No newline at end of file diff --git a/docs/library/generated/chainladder.ClarkLDF.rst b/docs/library/generated/chainladder.ClarkLDF.rst deleted file mode 100644 index 11e49a67..00000000 --- a/docs/library/generated/chainladder.ClarkLDF.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.ClarkLDF -==================== - -.. currentmodule:: chainladder - -.. autoclass:: ClarkLDF \ No newline at end of file diff --git a/docs/library/generated/chainladder.Development.rst b/docs/library/generated/chainladder.Development.rst deleted file mode 100644 index 216caf8b..00000000 --- a/docs/library/generated/chainladder.Development.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.Development -======================= - -.. currentmodule:: chainladder - -.. autoclass:: Development diff --git a/docs/library/generated/chainladder.DevelopmentConstant.rst b/docs/library/generated/chainladder.DevelopmentConstant.rst deleted file mode 100644 index 637e3b1c..00000000 --- a/docs/library/generated/chainladder.DevelopmentConstant.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.DevelopmentConstant -=============================== - -.. currentmodule:: chainladder - -.. autoclass:: DevelopmentConstant \ No newline at end of file diff --git a/docs/library/generated/chainladder.DevelopmentCorrelation.rst b/docs/library/generated/chainladder.DevelopmentCorrelation.rst deleted file mode 100644 index 2abe1bad..00000000 --- a/docs/library/generated/chainladder.DevelopmentCorrelation.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.DevelopmentCorrelation -================================== - -.. currentmodule:: chainladder - -.. autoclass:: DevelopmentCorrelation \ No newline at end of file diff --git a/docs/library/generated/chainladder.DevelopmentML.rst b/docs/library/generated/chainladder.DevelopmentML.rst deleted file mode 100644 index 9c9ae399..00000000 --- a/docs/library/generated/chainladder.DevelopmentML.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.DevelopmentML -========================= - -.. currentmodule:: chainladder - -.. autoclass:: DevelopmentML \ No newline at end of file diff --git a/docs/library/generated/chainladder.ExpectedLoss.rst b/docs/library/generated/chainladder.ExpectedLoss.rst deleted file mode 100644 index 222db062..00000000 --- a/docs/library/generated/chainladder.ExpectedLoss.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.ExpectedLoss -======================== - -.. currentmodule:: chainladder - -.. autoclass:: ExpectedLoss \ No newline at end of file diff --git a/docs/library/generated/chainladder.GridSearch.rst b/docs/library/generated/chainladder.GridSearch.rst deleted file mode 100644 index e3cb2dd8..00000000 --- a/docs/library/generated/chainladder.GridSearch.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.GridSearch -====================== - -.. currentmodule:: chainladder - -.. autoclass:: GridSearch \ No newline at end of file diff --git a/docs/library/generated/chainladder.IncrementalAdditive.rst b/docs/library/generated/chainladder.IncrementalAdditive.rst deleted file mode 100644 index d1258d33..00000000 --- a/docs/library/generated/chainladder.IncrementalAdditive.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.IncrementalAdditive -=============================== - -.. currentmodule:: chainladder - -.. autoclass:: IncrementalAdditive \ No newline at end of file diff --git a/docs/library/generated/chainladder.MackChainladder.rst b/docs/library/generated/chainladder.MackChainladder.rst deleted file mode 100644 index 73c68494..00000000 --- a/docs/library/generated/chainladder.MackChainladder.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.MackChainladder -=========================== - -.. currentmodule:: chainladder - -.. autoclass:: MackChainladder \ No newline at end of file diff --git a/docs/library/generated/chainladder.MunichAdjustment.rst b/docs/library/generated/chainladder.MunichAdjustment.rst deleted file mode 100644 index 1eb4d7ef..00000000 --- a/docs/library/generated/chainladder.MunichAdjustment.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.MunichAdjustment -============================ - -.. currentmodule:: chainladder - -.. autoclass:: MunichAdjustment \ No newline at end of file diff --git a/docs/library/generated/chainladder.ParallelogramOLF.rst b/docs/library/generated/chainladder.ParallelogramOLF.rst deleted file mode 100644 index 13d987ff..00000000 --- a/docs/library/generated/chainladder.ParallelogramOLF.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.ParallelogramOLF -============================ - -.. currentmodule:: chainladder - -.. autoclass:: ParallelogramOLF \ No newline at end of file diff --git a/docs/library/generated/chainladder.PatsyFormula.rst b/docs/library/generated/chainladder.PatsyFormula.rst deleted file mode 100644 index 60fe7df2..00000000 --- a/docs/library/generated/chainladder.PatsyFormula.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.PatsyFormula -======================== - -.. currentmodule:: chainladder - -.. autoclass:: PatsyFormula \ No newline at end of file diff --git a/docs/library/generated/chainladder.Pipeline.rst b/docs/library/generated/chainladder.Pipeline.rst deleted file mode 100644 index 6965fecf..00000000 --- a/docs/library/generated/chainladder.Pipeline.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.Pipeline -==================== - -.. currentmodule:: chainladder - -.. autoclass:: Pipeline \ No newline at end of file diff --git a/docs/library/generated/chainladder.TailBondy.rst b/docs/library/generated/chainladder.TailBondy.rst deleted file mode 100644 index f21a4899..00000000 --- a/docs/library/generated/chainladder.TailBondy.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.TailBondy -===================== - -.. currentmodule:: chainladder - -.. autoclass:: TailBondy \ No newline at end of file diff --git a/docs/library/generated/chainladder.TailClark.rst b/docs/library/generated/chainladder.TailClark.rst deleted file mode 100644 index 929329a8..00000000 --- a/docs/library/generated/chainladder.TailClark.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.TailClark -===================== - -.. currentmodule:: chainladder - -.. autoclass:: TailClark \ No newline at end of file diff --git a/docs/library/generated/chainladder.TailConstant.rst b/docs/library/generated/chainladder.TailConstant.rst deleted file mode 100644 index bcbc5565..00000000 --- a/docs/library/generated/chainladder.TailConstant.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.TailConstant -======================== - -.. currentmodule:: chainladder - -.. autoclass:: TailConstant \ No newline at end of file diff --git a/docs/library/generated/chainladder.TailCurve.rst b/docs/library/generated/chainladder.TailCurve.rst deleted file mode 100644 index d5309486..00000000 --- a/docs/library/generated/chainladder.TailCurve.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.TailCurve -===================== - -.. currentmodule:: chainladder - -.. autoclass:: TailCurve \ No newline at end of file diff --git a/docs/library/generated/chainladder.Trend.rst b/docs/library/generated/chainladder.Trend.rst deleted file mode 100644 index 58613b47..00000000 --- a/docs/library/generated/chainladder.Trend.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.Trend -================= - -.. currentmodule:: chainladder - -.. autoclass:: Trend \ No newline at end of file diff --git a/docs/library/generated/chainladder.Triangle.rst b/docs/library/generated/chainladder.Triangle.rst deleted file mode 100644 index e40d541f..00000000 --- a/docs/library/generated/chainladder.Triangle.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.Triangle -==================== - -.. currentmodule:: chainladder - -.. autoclass:: Triangle \ No newline at end of file diff --git a/docs/library/generated/chainladder.TweedieGLM.rst b/docs/library/generated/chainladder.TweedieGLM.rst deleted file mode 100644 index eec1dd4c..00000000 --- a/docs/library/generated/chainladder.TweedieGLM.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.TweedieGLM -====================== - -.. currentmodule:: chainladder - -.. autoclass:: TweedieGLM \ No newline at end of file diff --git a/docs/library/generated/chainladder.ValuationCorrelation.rst b/docs/library/generated/chainladder.ValuationCorrelation.rst deleted file mode 100644 index 50f0a9e3..00000000 --- a/docs/library/generated/chainladder.ValuationCorrelation.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.ValuationCorrelation -================================ - -.. currentmodule:: chainladder - -.. autoclass:: ValuationCorrelation \ No newline at end of file diff --git a/docs/library/generated/chainladder.VotingChainladder.rst b/docs/library/generated/chainladder.VotingChainladder.rst deleted file mode 100644 index 752c5e10..00000000 --- a/docs/library/generated/chainladder.VotingChainladder.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.VotingChainladder -============================= - -.. currentmodule:: chainladder - -.. autoclass:: VotingChainladder \ No newline at end of file diff --git a/docs/library/generated/chainladder.concat.rst b/docs/library/generated/chainladder.concat.rst deleted file mode 100644 index f024f7be..00000000 --- a/docs/library/generated/chainladder.concat.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.concat -================== - -.. currentmodule:: chainladder - -.. autofunction:: concat \ No newline at end of file diff --git a/docs/library/generated/chainladder.load_sample.rst b/docs/library/generated/chainladder.load_sample.rst deleted file mode 100644 index 360d742a..00000000 --- a/docs/library/generated/chainladder.load_sample.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.load\_sample -======================== - -.. currentmodule:: chainladder - -.. autofunction:: load_sample \ No newline at end of file diff --git a/docs/library/generated/chainladder.maximum.rst b/docs/library/generated/chainladder.maximum.rst deleted file mode 100644 index 09dce287..00000000 --- a/docs/library/generated/chainladder.maximum.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.maximum -=================== - -.. currentmodule:: chainladder - -.. autofunction:: maximum \ No newline at end of file diff --git a/docs/library/generated/chainladder.minimum.rst b/docs/library/generated/chainladder.minimum.rst deleted file mode 100644 index ead5399f..00000000 --- a/docs/library/generated/chainladder.minimum.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.minimum -=================== - -.. currentmodule:: chainladder - -.. autofunction:: minimum \ No newline at end of file diff --git a/docs/library/generated/chainladder.read_json.rst b/docs/library/generated/chainladder.read_json.rst deleted file mode 100644 index f28aad8e..00000000 --- a/docs/library/generated/chainladder.read_json.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.read\_json -====================== - -.. currentmodule:: chainladder - -.. autofunction:: read_json \ No newline at end of file diff --git a/docs/library/generated/chainladder.read_pickle.rst b/docs/library/generated/chainladder.read_pickle.rst deleted file mode 100644 index 407b810c..00000000 --- a/docs/library/generated/chainladder.read_pickle.rst +++ /dev/null @@ -1,6 +0,0 @@ -chainladder.read\_pickle -======================== - -.. currentmodule:: chainladder - -.. autofunction:: read_pickle \ No newline at end of file diff --git a/docs/library/references.bib b/docs/library/references.bib index aa718393..d83ef37f 100644 --- a/docs/library/references.bib +++ b/docs/library/references.bib @@ -69,7 +69,7 @@ @article{mack1993 title = {Distribution-{F}ree {C}alculation of {T}he {S}tandard {E}rror of {C}hain {L}adder {R}eserve {E}stimates}, journal = {ASTIN Bulletin, Vol. 23, No. 2, pp.213:225}, year = {1993}, - url = {http://www.actuaries.org/LIBRARY/ASTIN/vol23no2/213.pdf} + url = {https://www.casact.org/sites/default/files/2021-02/library_astin_vol23no2_213.pdf} } @article{mack1999, @@ -94,4 +94,4 @@ @article{barnett2008 journal = {Casualty Actuarial Society E-Forum}, year = {2008}, url = {https://www.casact.org/sites/default/files/database/forum_08fforum_3barnett_zehnwirth.pdf} -} \ No newline at end of file +} diff --git a/docs/user_guide/index.md b/docs/user_guide/index.md index f2d3460d..66ec196c 100644 --- a/docs/user_guide/index.md +++ b/docs/user_guide/index.md @@ -15,7 +15,7 @@ Data object to manage and manipulate reserving data **Application**: Extend pandas syntax to manipulate reserving triangles -```{glue:} plot_triangle_from_pandas +```{image} ../images/plot_triangle_from_pandas.png ``` +++ **Classes**: **[Triangle](triangle)**, ... @@ -30,7 +30,7 @@ Tooling to generate loss development patterns **Applications**: Comprehensive library for development -```{glue:} plot_clarkldf +```{image} ../images/plot_clarkldf.png ``` +++ @@ -47,7 +47,7 @@ Extrapolate development patterns beyond the known data. **Applications**: Long-tailed lines of business use cases -```{glue:} plot_exponential_smoothing +```{image} ../images/plot_exponential_smoothing.png ``` +++ @@ -65,7 +65,7 @@ Generate IBNR estimates and associated statistics **Applications**: Constructing reserve estimates -```{glue:} plot_mack +```{image} ../images/plot_mack.png ``` +++ @@ -83,7 +83,7 @@ Common actuarial data adjustments **Applications**: Simulation, trending, on-leveling -```{glue:} plot_stochastic_bornferg +```{image} ../images/plot_stochastic_bornferg.png ``` +++ @@ -100,7 +100,7 @@ Workflow tools for complex analyses **Application**: Scenario testing, ensembling -```{glue:} plot_voting_chainladder +```{image} ../images/plot_voting_chainladder.png ``` +++ diff --git a/docs/user_guide/methods.ipynb b/docs/user_guide/methods.ipynb index 6e8fefe6..69658057 100644 --- a/docs/user_guide/methods.ipynb +++ b/docs/user_guide/methods.ipynb @@ -526,12 +526,15 @@ "\n", "### Examples\n", "\n", - ":::{panels}\n", - ":column: col-lg-4 px-2 py-2\n", + "::::{grid}\n", + ":gutter: 2\n", "\n", - "---\n", - "**[MackChainladder Basics](plot_mack)**\n", - "```{glue:} plot_mack\n", + ":::{grid-item-card}\n", + ":columns: 4\n", + ":link: ...gallery/plot_mack\n", + ":link-type: doc\n", + "**[MackChainladder Basics]**\n", + "```{image} ../images/plot_mack.png\n", "```\n", "+++\n", "{bdg-success}`easy`\n",