Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Minyus committed Aug 14, 2019
1 parent f137fd0 commit fd408b5
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,22 +127,6 @@ Table data including the following columns:
</p>


## Updates for version 1.x

The latest version 1.x adopts [Kedro](https://kedro.readthedocs.io/) to add the following new
features and will be available soon in PyPI.

- [Parallel execution] Train the 2 models in parallel
- [File management] Save and load intermediate files such as the trained models
- [Documentation] Generate the API document by Sphinx and visualize the process flow

Other enhancements include:

- [Logging] Show and/or log processing status such as timestamp and the running task
- [Model options] Specify models other than XGBoost and Logistic Regression for uplift
modeling and propensity modeling, respectively.


## How to install CausalLift?

Option 1: install from the PyPI
Expand Down Expand Up @@ -237,6 +221,22 @@ estimated_effect_df = cl.estimate_recommendation_impact()
CausalLift flow diagram
</p>

## New features introduced in version 1.0.0

CausalLift version 1.0.0 adopted [Kedro](https://kedro.readthedocs.io/) to add the following new
features.

- [Parallel execution] Train the 2 models in parallel
- [File management] Save and load intermediate files such as the trained models
- [Documentation] Generate the API document by Sphinx and visualize the process flow

Other enhancements include:

- [Logging] Show and/or log processing status such as timestamp and the running task
- [Model options] Specify models other than XGBoost and Logistic Regression for uplift
modeling and propensity modeling, respectively.


## Details about the parameters

Please see [[CausalLift API reference]](https://minyus.github.io/causallift/causallift.html).
Expand Down

0 comments on commit fd408b5

Please sign in to comment.