<div align="left">
[](https://github.com/retentioneering/retentioneering-tools)
[](https://pypi.org/project/retentioneering/)
[](https://t.me/retentioneering_meetups)
[](https://pypi.org/project/retentioneering/)
[](https://pepy.tech/project/retentioneering)
[](https://travis-ci.com/github/retentioneering/retentioneering-tools)
## What is Retentioneering?
Retentioneering is a Python framework and library to assist product analysts and
marketing analysts as it makes it easier to process and analyze clickstreams,
event streams, trajectories, and event logs. You can segment users, clients
(agents), build ML pipelines to predict agent category or probability of
target event based on historical data.
In a common scenario you can use raw data from Google Analytics BigQuery stream
or any other silimal streams in form of events and their timestamps for users,
and Retentioneering is all you need to explore the user behavior from that data,
it can reveal much more isights than funnel analytics, as it will automatically
build the behavioral segments and their patterns, highlighting what events and
pattern impact your conversion rates, retention and revenue.
Retentioneering extends Pandas, NetworkX, Scikit-learn for in-depth processing
of event sequences data, specifically Retentioneering provides a powerful environment
to perform an in-depth analysis of customer journey maps, bringing behavior-driven
segmentation of users and machine learning pipelines to product analytics.
Most recent is Retentioneering 2.0.0, this version has major updates from 1.0.x
and it is not reverse compatible with previous releases due to major syntax changes.
With significant improvements we now provided architecture and the solid ground for
farther updates and rapid development of analytical tools. Please update, leave your
feedback and stay tuned.
[](https://github.com/retentioneering/retentioneering-tools)
## Changelog
This is new major release Retentioneering 2.0. Change log is available [here](https://retentioneering.github.io/retentioneering-tools/_build/html/release_notes.html).
Complete documentation is available [here](https://retentioneering.github.io/retentioneering-tools/).
## Installation
Option 1. Run directly from google.colab. Open google.colab and click File-> “new notebook”.
In the code cell run following to install Retentioneering (same command will install directly
from Jupyter notebook):
```bash
!pip3 install retentioneering
```
Option 2. Install Retentioneering from PyPI:
```bash
pip3 install retentioneering
```
Option 3. Install Retentioneering directly from the source:
```bash
git clone https://github.com/retentioneering/retentioneering-tools
cd retentioneering-tools
python3 setup.py install
```
## Quick start
[Start using Retentioneering for clickstream analysis](https://retentioneering.github.io/retentioneering-tools/_build/html/getting_started.html)
Or directly open this notebook in [Google Colab](https://colab.research.google.com/github/retentioneering/retentioneering-tools/blob/master/docs/source/_static/examples/graph_tutorial.ipynb) to run with sample data.
Suggested first steps:
```python
import retentioneering
# load sample user behavior data as a pandas dataframe:
data = retentioneering.datasets.load_simple_shop()
# update config to pass columns names:
retentioneering.config.update({
'user_col': 'user_id',
'event_col':'event',
'event_time_col':'timestamp',
})
```
Above we imported sample dataset, which is regular pandas dataframe containing raw user
behavior data from hypothetical web-site or app in form of sequence of records
{'user_id', 'event', 'timestamp'}, and pass those column names to retentioneering.config.
Now, let's plot the graph to visualize user behaviour from the dataset
(read more about graphs [here](https://retentioneering.github.io/retentioneering-tools/_build/html/plot_graph.html)):
<div align="left">
```python
data.rete.plot_graph(norm_type='node',
weight_col='user_id',
thresh=0.2,
targets = {'payment_done':'green',
'lost':'red'})
```
[](https://github.com/retentioneering/retentioneering-tools)
Here we obtain the high-level graph of user activity where
edge A --> B weight shows percent of users transitioning to event B from
all users reached event A (note, edges with small weighs are
thresholded to avoid visual clutter, read more in the documentation)
To automatically find distinct behavioral patterns we can cluster users from the
dataset based on their behavior (read more about behavioral clustering [here](https://retentioneering.github.io/retentioneering-tools/_build/html/clustering.html)):
<div align="left">
```pyhton
data.rete.get_clusters(method='kmeans',
n_clusters=8,
ngram_range=(1,2),
plot_type='cluster_bar',
targets=['payment_done','cart']);
```
[](https://github.com/retentioneering/retentioneering-tools)
<div align="left">
Users with similar behavior grouped in the same cluster. Clusters with low conversion rate
can represent systematic problem in the product: specific behavior pattern which does not
lead to product goals. Obtained user segments can be explored deeper to understand
problematic behavior pattern. In the example above for instance, cluster 4 has low
conversion rate to purchase but high conversion rate to cart visit.
```python
clus_4 = data.rete.filter_cluster(4)
clus_4.rete.plot_graph(thresh=0.1,
weight_col='user_id',
targets = {'lost':'red',
'payment_done':'green'})
```
<div align="left">
[](https://github.com/retentioneering/retentioneering-tools)
To explore more features please see the [documentation](https://retentioneering.github.io/retentioneering-tools/)
## Step-by-step guides
- [Visualize users behavior](https://retentioneering.github.io/retentioneering-tools/_build/html/plot_graph.html)
- [Users flow and step matrix](https://retentioneering.github.io/retentioneering-tools/_build/html/step_matrix.html)
- [Users behavioral segmentation](https://retentioneering.github.io/retentioneering-tools/_build/html/clustering.html)
- [Compare segments and AB tests](https://retentioneering.github.io/retentioneering-tools/_build/html/compare.html)
- [Funnel analysis](https://retentioneering.github.io/retentioneering-tools/_build/html/funnel.html)
## Contributing
This is community-driven open source project in active development. Any contributions,
new ideas, bug reports, bug fixes, documentation improvements are very welcome.
Retentioneering now provides several opensource solutions for data-driven product
analytics and web analytics. Please checkout this repository for JS library to track
the mutations of the website elements: https://github.com/retentioneering/retentioneering-dom-observer
Apps are better with math!:)
Retentioneering is a research laboratory, analytics methodology and opensource
tools founded by [Maxim Godzi](https://www.linkedin.com/in/godsie/) and
[Anatoly Zay
Retentioneering工具：Retentioneering：产品分析，数据驱动的客户旅程图优化，营销分析，Web分析，交易分析，图形可视化以及使用Python进行客户细分的行为细分。 开源分析，点击流的预测分析，情感分析，AB测试，机器学习和Monte Carlo Markov Chain模拟，扩展了Pandas，Networkx和sklearn （367个子文件） 
make.bat 756B .buildinfo 230B theme.css 121KB basic.css 13KB pygments.css 4KB badge_only.css 3KB ab_test_demo.csv 1.82MB simple-onlineshop.csv 1.52MB retentioneering.core.doctree 127KB step_matrix.doctree 49KB clustering.doctree 47KB compare.doctree 32KB plot_graph.doctree 32KB funnel.doctree 19KB getting_started.doctree 18KB transition_matrix.doctree 12KB release_notes.doctree 11KB index.doctree 11KB what_is_rete.doctree 8KB installation.doctree 5KB .DS_Store 10KB lato-italic.eot 262KB lato-bolditalic.eot 260KB lato-bold.eot 250KB lato-regular.eot 248KB fontawesome-webfont.eot 162KB fontawesome-webfont.eot 162KB roboto-slab-v7-bold.eot 78KB roboto-slab-v7-regular.eot 76KB .gitignore 1KB
funnel_2.html 3.26MB funnel_2.html 3.26MB funnel_1b.html 3.26MB funnel_1b.html 3.26MB funnel_1.html 3.26MB funnel_1.html 3.26MB funnel_0.html 3.26MB funnel_0.html 3.26MB step_matrix.html 65KB get_clusters.html 42KB retentioneering.core.html 39KB step_matrix.html 38KB index_4.html 38KB index_4.html 38KB clustering.html 38KB index_2.html 37KB index_2.html 37KB index_3.html 37KB index_3.html 37KB index_1.html 36KB index_1.html 36KB index.html 36KB index.html 36KB index_1b.html 36KB index_1b.html 36KB index_0.html 33KB index_0.html 33KB index_0.html 28KB index_0.html 28KB compare.html 27KB compare.html 27KB extract_features.html 26KB plot_graph.html 25KB funnel.html 20KB project.html 18KB getting_started.html 17KB get_edgelist.html 17KB plot_graph.html 16KB index.html 15KB funnel.html 15KB transition_matrix.html 13KB genindex.html 13KB get_adjacency.html 11KB release_notes.html 9KB what_is_rete.html 9KB py-modindex.html 9KB installation.html 8KB index.html 7KB search.html 6KB footer.html 305B index.html 71B objects.inv 661B funnel_tutorial.ipynb 3.47MB funnel_tutorial.ipynb 3.47MB funnel_tutorial.ipynb 3.47MB funnel_tutorial.ipynb 3.47MB step_matrix_tutorial.ipynb 1.18MB step_matrix_tutorial.ipynb 1.18MB step_matrix_tutorial.ipynb 1.18MB step_matrix_tutorial.ipynb 1.18MB clusters_tutorial.ipynb 666KB clusters_tutorial.ipynb 666KB clusters_tutorial.ipynb 666KB clusters_tutorial.ipynb 666KB graph_tutorial.ipynb 326KB graph_tutorial.ipynb 326KB graph_tutorial.ipynb 326KB graph_tutorial.ipynb 321KB YM_loader.ipynb 122KB compare_tutorial.ipynb 61KB共 367 条
- 1
- 2
- 3
- 4
评论0