Updated docs

This commit is contained in:
Enrico Zimuel 2023-08-24 11:12:30 +02:00
parent ebdebdf16f
commit 2304fdc593
No known key found for this signature in database
GPG Key ID: 6CB203F6934A69F1
133 changed files with 545 additions and 294 deletions

View File

@ -1,6 +1,6 @@
eland.DataFrame.agg
eland.DataFrame.agg
===================
.. currentmodule:: eland
.. automethod:: DataFrame.agg
.. automethod:: DataFrame.agg

View File

@ -1,6 +1,6 @@
eland.DataFrame.aggregate
eland.DataFrame.aggregate
=========================
.. currentmodule:: eland
.. automethod:: DataFrame.aggregate
.. automethod:: DataFrame.aggregate

View File

@ -1,6 +1,6 @@
eland.DataFrame.columns
eland.DataFrame.columns
=======================
.. currentmodule:: eland
.. autoattribute:: DataFrame.columns
.. autoproperty:: DataFrame.columns

View File

@ -1,6 +1,6 @@
eland.DataFrame.count
eland.DataFrame.count
=====================
.. currentmodule:: eland
.. automethod:: DataFrame.count
.. automethod:: DataFrame.count

View File

@ -1,6 +1,6 @@
eland.DataFrame.describe
eland.DataFrame.describe
========================
.. currentmodule:: eland
.. automethod:: DataFrame.describe
.. automethod:: DataFrame.describe

View File

@ -1,6 +1,6 @@
eland.DataFrame.drop
eland.DataFrame.drop
====================
.. currentmodule:: eland
.. automethod:: DataFrame.drop
.. automethod:: DataFrame.drop

View File

@ -1,6 +1,6 @@
eland.DataFrame.dtypes
eland.DataFrame.dtypes
======================
.. currentmodule:: eland
.. autoattribute:: DataFrame.dtypes
.. autoproperty:: DataFrame.dtypes

View File

@ -1,6 +1,6 @@
eland.DataFrame.empty
eland.DataFrame.empty
=====================
.. currentmodule:: eland
.. autoattribute:: DataFrame.empty
.. autoproperty:: DataFrame.empty

View File

@ -1,6 +1,6 @@
eland.DataFrame.es_dtypes
=========================
eland.DataFrame.es\_dtypes
==========================
.. currentmodule:: eland
.. autoattribute:: DataFrame.es_dtypes
.. autoproperty:: DataFrame.es_dtypes

View File

@ -1,6 +1,6 @@
eland.DataFrame.es_info
=======================
eland.DataFrame.es\_info
========================
.. currentmodule:: eland
.. automethod:: DataFrame.es_info
.. automethod:: DataFrame.es_info

View File

@ -1,6 +1,6 @@
eland.DataFrame.es_match
========================
eland.DataFrame.es\_match
=========================
.. currentmodule:: eland
.. automethod:: DataFrame.es_match
.. automethod:: DataFrame.es_match

View File

@ -1,6 +1,6 @@
eland.DataFrame.es_query
========================
eland.DataFrame.es\_query
=========================
.. currentmodule:: eland
.. automethod:: DataFrame.es_query
.. automethod:: DataFrame.es_query

View File

@ -1,6 +1,6 @@
eland.DataFrame.filter
eland.DataFrame.filter
======================
.. currentmodule:: eland
.. automethod:: DataFrame.filter
.. automethod:: DataFrame.filter

View File

@ -1,6 +1,6 @@
eland.DataFrame.get
eland.DataFrame.get
===================
.. currentmodule:: eland
.. automethod:: DataFrame.get
.. automethod:: DataFrame.get

View File

@ -1,6 +1,6 @@
eland.DataFrame.groupby
eland.DataFrame.groupby
=======================
.. currentmodule:: eland
.. automethod:: DataFrame.groupby
.. automethod:: DataFrame.groupby

View File

@ -1,6 +1,6 @@
eland.DataFrame.head
eland.DataFrame.head
====================
.. currentmodule:: eland
.. automethod:: DataFrame.head
.. automethod:: DataFrame.head

View File

@ -1,8 +1,6 @@
eland.DataFrame.hist
eland.DataFrame.hist
====================
.. currentmodule:: eland
.. automethod:: DataFrame.hist
.. image:: eland-DataFrame-hist-1.png
.. automethod:: DataFrame.hist

View File

@ -1,6 +1,6 @@
eland.DataFrame.idxmax
========================
eland.DataFrame.idxmax
======================
.. currentmodule:: eland
.. automethod:: DataFrame.idxmax
.. automethod:: DataFrame.idxmax

View File

@ -1,6 +1,6 @@
eland.DataFrame.idxmin
========================
eland.DataFrame.idxmin
======================
.. currentmodule:: eland
.. automethod:: DataFrame.idxmin
.. automethod:: DataFrame.idxmin

View File

@ -1,6 +1,6 @@
eland.DataFrame.index
eland.DataFrame.index
=====================
.. currentmodule:: eland
.. autoattribute:: DataFrame.index
.. autoproperty:: DataFrame.index

View File

@ -1,6 +1,6 @@
eland.DataFrame.info
eland.DataFrame.info
====================
.. currentmodule:: eland
.. automethod:: DataFrame.info
.. automethod:: DataFrame.info

View File

@ -1,6 +1,6 @@
eland.DataFrame.iterrows
eland.DataFrame.iterrows
========================
.. currentmodule:: eland
.. automethod:: DataFrame.iterrows
.. automethod:: DataFrame.iterrows

View File

@ -1,6 +1,6 @@
eland.DataFrame.itertuples
eland.DataFrame.itertuples
==========================
.. currentmodule:: eland
.. automethod:: DataFrame.itertuples
.. automethod:: DataFrame.itertuples

View File

@ -1,6 +1,6 @@
eland.DataFrame.keys
eland.DataFrame.keys
====================
.. currentmodule:: eland
.. automethod:: DataFrame.keys
.. automethod:: DataFrame.keys

View File

@ -1,6 +1,6 @@
eland.DataFrame.mad
eland.DataFrame.mad
===================
.. currentmodule:: eland
.. automethod:: DataFrame.mad
.. automethod:: DataFrame.mad

View File

@ -1,6 +1,6 @@
eland.DataFrame.max
eland.DataFrame.max
===================
.. currentmodule:: eland
.. automethod:: DataFrame.max
.. automethod:: DataFrame.max

View File

@ -1,6 +1,6 @@
eland.DataFrame.mean
eland.DataFrame.mean
====================
.. currentmodule:: eland
.. automethod:: DataFrame.mean
.. automethod:: DataFrame.mean

View File

@ -1,6 +1,6 @@
eland.DataFrame.median
eland.DataFrame.median
======================
.. currentmodule:: eland
.. automethod:: DataFrame.median
.. automethod:: DataFrame.median

View File

@ -1,6 +1,6 @@
eland.DataFrame.min
eland.DataFrame.min
===================
.. currentmodule:: eland
.. automethod:: DataFrame.min
.. automethod:: DataFrame.min

View File

@ -1,6 +1,6 @@
eland.DataFrame.ndim
eland.DataFrame.ndim
====================
.. currentmodule:: eland
.. autoattribute:: DataFrame.ndim
.. autoproperty:: DataFrame.ndim

View File

@ -1,6 +1,6 @@
eland.DataFrame.nunique
eland.DataFrame.nunique
=======================
.. currentmodule:: eland
.. automethod:: DataFrame.nunique
.. automethod:: DataFrame.nunique

View File

@ -1,6 +1,6 @@
eland.DataFrame.query
eland.DataFrame.query
=====================
.. currentmodule:: eland
.. automethod:: DataFrame.query
.. automethod:: DataFrame.query

View File

@ -1,6 +1,75 @@
eland.DataFrame
================
eland.DataFrame
===============
.. currentmodule:: eland
.. autoclass:: DataFrame
.. automethod:: __init__
.. rubric:: Methods
.. autosummary::
~DataFrame.__init__
~DataFrame.agg
~DataFrame.aggregate
~DataFrame.count
~DataFrame.describe
~DataFrame.drop
~DataFrame.es_info
~DataFrame.es_match
~DataFrame.es_query
~DataFrame.filter
~DataFrame.get
~DataFrame.groupby
~DataFrame.head
~DataFrame.hist
~DataFrame.idxmax
~DataFrame.idxmin
~DataFrame.info
~DataFrame.iterrows
~DataFrame.itertuples
~DataFrame.keys
~DataFrame.mad
~DataFrame.max
~DataFrame.mean
~DataFrame.median
~DataFrame.min
~DataFrame.mode
~DataFrame.nunique
~DataFrame.quantile
~DataFrame.query
~DataFrame.sample
~DataFrame.select_dtypes
~DataFrame.std
~DataFrame.sum
~DataFrame.tail
~DataFrame.to_csv
~DataFrame.to_html
~DataFrame.to_numpy
~DataFrame.to_pandas
~DataFrame.to_string
~DataFrame.var
.. rubric:: Attributes
.. autosummary::
~DataFrame.columns
~DataFrame.dtypes
~DataFrame.empty
~DataFrame.es_dtypes
~DataFrame.index
~DataFrame.ndim
~DataFrame.shape
~DataFrame.size
~DataFrame.values

View File

@ -1,6 +1,6 @@
eland.DataFrame.sample
eland.DataFrame.sample
======================
.. currentmodule:: eland
.. automethod:: DataFrame.sample
.. automethod:: DataFrame.sample

View File

@ -1,6 +1,6 @@
eland.DataFrame.select_dtypes
=============================
eland.DataFrame.select\_dtypes
==============================
.. currentmodule:: eland
.. automethod:: DataFrame.select_dtypes
.. automethod:: DataFrame.select_dtypes

View File

@ -1,6 +1,6 @@
eland.DataFrame.shape
eland.DataFrame.shape
=====================
.. currentmodule:: eland
.. autoattribute:: DataFrame.shape
.. autoproperty:: DataFrame.shape

View File

@ -1,6 +1,6 @@
eland.DataFrame.size
eland.DataFrame.size
====================
.. currentmodule:: eland
.. autoattribute:: DataFrame.size
.. autoproperty:: DataFrame.size

View File

@ -1,6 +1,6 @@
eland.DataFrame.std
eland.DataFrame.std
===================
.. currentmodule:: eland
.. automethod:: DataFrame.std
.. automethod:: DataFrame.std

View File

@ -1,6 +1,6 @@
eland.DataFrame.sum
eland.DataFrame.sum
===================
.. currentmodule:: eland
.. automethod:: DataFrame.sum
.. automethod:: DataFrame.sum

View File

@ -1,6 +1,6 @@
eland.DataFrame.tail
eland.DataFrame.tail
====================
.. currentmodule:: eland
.. automethod:: DataFrame.tail
.. automethod:: DataFrame.tail

View File

@ -1,6 +1,6 @@
eland.DataFrame.to_csv
======================
eland.DataFrame.to\_csv
=======================
.. currentmodule:: eland
.. automethod:: DataFrame.to_csv
.. automethod:: DataFrame.to_csv

View File

@ -1,6 +1,6 @@
eland.DataFrame.to_html
=======================
eland.DataFrame.to\_html
========================
.. currentmodule:: eland
.. automethod:: DataFrame.to_html
.. automethod:: DataFrame.to_html

View File

@ -1,6 +1,6 @@
eland.DataFrame.to_numpy
========================
eland.DataFrame.to\_numpy
=========================
.. currentmodule:: eland
.. automethod:: DataFrame.to_numpy
.. automethod:: DataFrame.to_numpy

View File

@ -1,6 +1,6 @@
eland.DataFrame.to_pandas
=========================
eland.DataFrame.to\_pandas
==========================
.. currentmodule:: eland
.. automethod:: DataFrame.to_pandas
.. automethod:: DataFrame.to_pandas

View File

@ -1,6 +1,6 @@
eland.DataFrame.to_string
=========================
eland.DataFrame.to\_string
==========================
.. currentmodule:: eland
.. automethod:: DataFrame.to_string
.. automethod:: DataFrame.to_string

View File

@ -1,6 +1,6 @@
eland.DataFrame.values
eland.DataFrame.values
======================
.. currentmodule:: eland
.. autoattribute:: DataFrame.values
.. autoproperty:: DataFrame.values

View File

@ -1,6 +1,6 @@
eland.DataFrame.var
eland.DataFrame.var
===================
.. currentmodule:: eland
.. automethod:: DataFrame.var
.. automethod:: DataFrame.var

View File

@ -1,6 +1,33 @@
eland.Index
eland.Index
===========
.. currentmodule:: eland
.. autoclass:: Index
.. automethod:: __init__
.. rubric:: Methods
.. autosummary::
~Index.__init__
~Index.es_info
.. rubric:: Attributes
.. autosummary::
~Index.ID_INDEX_FIELD
~Index.ID_SORT_FIELD
~Index.es_index_field
~Index.is_source_field
~Index.sort_field

View File

@ -1,6 +1,6 @@
eland.Series.add
eland.Series.add
================
.. currentmodule:: eland
.. automethod:: Series.add
.. automethod:: Series.add

View File

@ -1,6 +1,6 @@
eland.Series.describe
eland.Series.describe
=====================
.. currentmodule:: eland
.. automethod:: Series.describe
.. automethod:: Series.describe

View File

@ -1,6 +1,6 @@
eland.Series.div
eland.Series.div
================
.. currentmodule:: eland
.. automethod:: Series.div
.. automethod:: Series.div

View File

@ -1,6 +1,6 @@
eland.Series.divide
eland.Series.divide
===================
.. currentmodule:: eland
.. automethod:: Series.divide
.. automethod:: Series.divide

View File

@ -1,6 +1,6 @@
eland.Series.dtype
eland.Series.dtype
==================
.. currentmodule:: eland
.. autoattribute:: Series.dtype
.. autoproperty:: Series.dtype

View File

@ -1,6 +1,6 @@
eland.Series.dtypes
eland.Series.dtypes
===================
.. currentmodule:: eland
.. autoattribute:: Series.dtypes
.. autoproperty:: Series.dtypes

View File

@ -1,6 +1,6 @@
eland.Series.empty
eland.Series.empty
==================
.. currentmodule:: eland
.. autoattribute:: Series.empty
.. autoproperty:: Series.empty

View File

@ -1,6 +1,6 @@
eland.Series.es_dtype
=====================
eland.Series.es\_dtype
======================
.. currentmodule:: eland
.. autoattribute:: Series.es_dtype
.. autoproperty:: Series.es_dtype

View File

@ -1,6 +1,6 @@
eland.Series.es_dtypes
======================
eland.Series.es\_dtypes
=======================
.. currentmodule:: eland
.. autoattribute:: Series.es_dtypes
.. autoproperty:: Series.es_dtypes

View File

@ -1,6 +1,6 @@
eland.Series.es_info
====================
eland.Series.es\_info
=====================
.. currentmodule:: eland
.. automethod:: Series.es_info
.. automethod:: Series.es_info

View File

@ -1,6 +1,6 @@
eland.Series.es_match
=====================
eland.Series.es\_match
======================
.. currentmodule:: eland
.. automethod:: Series.es_match
.. automethod:: Series.es_match

View File

@ -1,6 +1,6 @@
eland.Series.filter
eland.Series.filter
===================
.. currentmodule:: eland
.. automethod:: Series.filter
.. automethod:: Series.filter

View File

@ -1,6 +1,6 @@
eland.Series.floordiv
eland.Series.floordiv
=====================
.. currentmodule:: eland
.. automethod:: Series.floordiv
.. automethod:: Series.floordiv

View File

@ -1,6 +1,6 @@
eland.Series.head
eland.Series.head
=================
.. currentmodule:: eland
.. automethod:: Series.head
.. automethod:: Series.head

View File

@ -1,8 +1,6 @@
eland.Series.hist
====================
eland.Series.hist
=================
.. currentmodule:: eland
.. automethod:: Series.hist
.. image:: eland-Series-hist-2.png
.. automethod:: Series.hist

View File

@ -1,6 +1,6 @@
eland.Series.index
eland.Series.index
==================
.. currentmodule:: eland
.. autoattribute:: Series.index
.. autoproperty:: Series.index

View File

@ -1,6 +1,6 @@
eland.Series.isin
eland.Series.isin
=================
.. currentmodule:: eland
.. automethod:: Series.isin
.. automethod:: Series.isin

View File

@ -1,6 +1,6 @@
eland.Series.isna
==================
eland.Series.isna
=================
.. currentmodule:: eland
.. automethod:: Series.isna
.. automethod:: Series.isna

View File

@ -1,6 +1,6 @@
eland.Series.isnull
eland.Series.isnull
===================
.. currentmodule:: eland
.. automethod:: Series.isnull
.. automethod:: Series.isnull

View File

@ -1,6 +1,6 @@
eland.Series.mad
eland.Series.mad
================
.. currentmodule:: eland
.. automethod:: Series.mad
.. automethod:: Series.mad

View File

@ -1,6 +1,6 @@
eland.Series.max
eland.Series.max
================
.. currentmodule:: eland
.. automethod:: Series.max
.. automethod:: Series.max

View File

@ -1,6 +1,6 @@
eland.Series.mean
eland.Series.mean
=================
.. currentmodule:: eland
.. automethod:: Series.mean
.. automethod:: Series.mean

View File

@ -1,6 +1,6 @@
eland.Series.median
eland.Series.median
===================
.. currentmodule:: eland
.. automethod:: Series.median
.. automethod:: Series.median

View File

@ -1,6 +1,6 @@
eland.Series.min
eland.Series.min
================
.. currentmodule:: eland
.. automethod:: Series.min
.. automethod:: Series.min

View File

@ -1,6 +1,6 @@
eland.Series.mod
eland.Series.mod
================
.. currentmodule:: eland
.. automethod:: Series.mod
.. automethod:: Series.mod

View File

@ -1,5 +1,5 @@
eland.Series.mode
====================
eland.Series.mode
=================
.. currentmodule:: eland

View File

@ -1,6 +1,6 @@
eland.Series.mul
eland.Series.mul
================
.. currentmodule:: eland
.. automethod:: Series.mul
.. automethod:: Series.mul

View File

@ -1,6 +1,6 @@
eland.Series.multiply
eland.Series.multiply
=====================
.. currentmodule:: eland
.. automethod:: Series.multiply
.. automethod:: Series.multiply

View File

@ -1,6 +1,6 @@
eland.Series.name
eland.Series.name
=================
.. currentmodule:: eland
.. autoattribute:: Series.name
.. autoproperty:: Series.name

View File

@ -1,6 +1,6 @@
eland.Series.ndim
eland.Series.ndim
=================
.. currentmodule:: eland
.. autoattribute:: Series.ndim
.. autoproperty:: Series.ndim

View File

@ -1,6 +1,6 @@
eland.Series.notna
eland.Series.notna
==================
.. currentmodule:: eland
.. automethod:: Series.notna
.. automethod:: Series.notna

View File

@ -1,6 +1,6 @@
eland.Series.notnull
eland.Series.notnull
====================
.. currentmodule:: eland
.. automethod:: Series.notnull
.. automethod:: Series.notnull

View File

@ -1,6 +1,6 @@
eland.Series.nunique
eland.Series.nunique
====================
.. currentmodule:: eland
.. automethod:: Series.nunique
.. automethod:: Series.nunique

View File

@ -1,6 +1,6 @@
eland.Series.pow
eland.Series.pow
================
.. currentmodule:: eland
.. automethod:: Series.pow
.. automethod:: Series.pow

View File

@ -1,6 +1,6 @@
eland.Series.radd
eland.Series.radd
=================
.. currentmodule:: eland
.. automethod:: Series.radd
.. automethod:: Series.radd

View File

@ -1,6 +1,6 @@
eland.Series.rdiv
eland.Series.rdiv
=================
.. currentmodule:: eland
.. automethod:: Series.rdiv
.. automethod:: Series.rdiv

View File

@ -1,6 +1,6 @@
eland.Series.rdivide
eland.Series.rdivide
====================
.. currentmodule:: eland
.. automethod:: Series.rdivide
.. automethod:: Series.rdivide

View File

@ -1,6 +1,6 @@
eland.Series.rename
eland.Series.rename
===================
.. currentmodule:: eland
.. automethod:: Series.rename
.. automethod:: Series.rename

View File

@ -1,6 +1,6 @@
eland.Series.rfloordiv
eland.Series.rfloordiv
======================
.. currentmodule:: eland
.. automethod:: Series.rfloordiv
.. automethod:: Series.rfloordiv

View File

@ -1,6 +1,6 @@
eland.Series.rmod
eland.Series.rmod
=================
.. currentmodule:: eland
.. automethod:: Series.rmod
.. automethod:: Series.rmod

View File

@ -1,6 +1,6 @@
eland.Series.rmul
eland.Series.rmul
=================
.. currentmodule:: eland
.. automethod:: Series.rmul
.. automethod:: Series.rmul

View File

@ -1,6 +1,6 @@
eland.Series.rmultiply
eland.Series.rmultiply
======================
.. currentmodule:: eland
.. automethod:: Series.rmultiply
.. automethod:: Series.rmultiply

View File

@ -1,6 +1,6 @@
eland.Series.rpow
eland.Series.rpow
=================
.. currentmodule:: eland
.. automethod:: Series.rpow
.. automethod:: Series.rpow

View File

@ -1,6 +1,90 @@
eland.Series
eland.Series
============
.. currentmodule:: eland
.. autoclass:: Series
.. automethod:: __init__
.. rubric:: Methods
.. autosummary::
~Series.__init__
~Series.add
~Series.describe
~Series.div
~Series.divide
~Series.es_info
~Series.es_match
~Series.filter
~Series.floordiv
~Series.head
~Series.hist
~Series.isin
~Series.isna
~Series.isnull
~Series.mad
~Series.max
~Series.mean
~Series.median
~Series.min
~Series.mod
~Series.mode
~Series.mul
~Series.multiply
~Series.notna
~Series.notnull
~Series.nunique
~Series.pow
~Series.quantile
~Series.radd
~Series.rdiv
~Series.rdivide
~Series.rename
~Series.rfloordiv
~Series.rmod
~Series.rmul
~Series.rmultiply
~Series.rpow
~Series.rsub
~Series.rsubtract
~Series.rtruediv
~Series.sample
~Series.std
~Series.sub
~Series.subtract
~Series.sum
~Series.tail
~Series.to_numpy
~Series.to_pandas
~Series.to_string
~Series.truediv
~Series.unique
~Series.value_counts
~Series.var
.. rubric:: Attributes
.. autosummary::
~Series.dtype
~Series.dtypes
~Series.empty
~Series.es_dtype
~Series.es_dtypes
~Series.es_field_name
~Series.index
~Series.name
~Series.ndim
~Series.shape
~Series.size

View File

@ -1,6 +1,6 @@
eland.Series.rsub
eland.Series.rsub
=================
.. currentmodule:: eland
.. automethod:: Series.rsub
.. automethod:: Series.rsub

View File

@ -1,6 +1,6 @@
eland.Series.rsubtract
eland.Series.rsubtract
======================
.. currentmodule:: eland
.. automethod:: Series.rsubtract
.. automethod:: Series.rsubtract

View File

@ -1,6 +1,6 @@
eland.Series.rtruediv
eland.Series.rtruediv
=====================
.. currentmodule:: eland
.. automethod:: Series.rtruediv
.. automethod:: Series.rtruediv

View File

@ -1,6 +1,6 @@
eland.Series.sample
eland.Series.sample
===================
.. currentmodule:: eland
.. automethod:: Series.sample
.. automethod:: Series.sample

View File

@ -1,6 +1,6 @@
eland.Series.shape
eland.Series.shape
==================
.. currentmodule:: eland
.. autoattribute:: Series.shape
.. autoproperty:: Series.shape

View File

@ -1,6 +1,6 @@
eland.Series.size
eland.Series.size
=================
.. currentmodule:: eland
.. autoattribute:: Series.size
.. autoproperty:: Series.size

View File

@ -1,6 +1,6 @@
eland.Series.std
eland.Series.std
================
.. currentmodule:: eland
.. automethod:: Series.std
.. automethod:: Series.std

View File

@ -1,6 +1,6 @@
eland.Series.sub
eland.Series.sub
================
.. currentmodule:: eland
.. automethod:: Series.sub
.. automethod:: Series.sub

Some files were not shown because too many files have changed in this diff Show More