Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: overhaul #105

Merged
merged 13 commits into from
Sep 6, 2023
193 changes: 0 additions & 193 deletions docs/advanced.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/api_reference.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
API reference
API Reference
=============

.. toctree::
Expand Down
37 changes: 0 additions & 37 deletions docs/getting_started.rst

This file was deleted.

37 changes: 25 additions & 12 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,27 @@
EDVART
================================

Exploratory Data Analysis (EDA) is a very initial task a data scientist
or data analyst does when he reaches new data.
EDA refers to the critical process of performing
initial investigations on data to discover patterns, to spot
anomalies, to test hypothesis and to check assumptions with the help
of summary statistics and graphical representations.
Edvart is an open-source Python library designed to simplify and streamline
your exploratory data analysis (EDA) process.
Edvart supports different levels of customization:
from a default report generated in one line of code to a fully-customized
report down to the level of code generating the visualizations.

lukany marked this conversation as resolved.
Show resolved Hide resolved
Key Features
------------
* **One-line Reports**: Generate a comprehensive set of pandas DataFrame visualizations using a single Python statement.
Edvart supports:
* Data overview,
* Univariate analysis,
* Bivariate analysis,
* Multivariate analysis,
* Grouped analysis,
* Time series analysis.

* **Customizable Reports**: Produce, iterate, and style detailed reports in Jupyter notebooks and HTML formats.
* **Flexible API**: From high-level simplicity in a single line of code to detailed control, choose the API level that fits your needs.
* **Interactive Visualizations**: Many of the visualizations are interactive and can be used to explore the data in detail.

EDVART serves for speeding up EDA and for
creating Data analysis reports.

Table of Contents
-----------------
Expand All @@ -18,15 +30,16 @@ Table of Contents
:maxdepth: 2

installation.rst
getting_started.rst
advanced.rst
usage.rst
sections.rst
api_reference.rst

.. include:: installation.rst
.. include:: getting_started.rst
.. include:: usage.rst
.. include:: sections.rst

Links
-----------
-----
* `GitHub repository <https://github.com/datamole-ai/edvart>`_

* :ref:`modindex`
Loading