You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* resolves#780, remove support for env files
* add nudge to export env, remove reference to env files
---------
Co-authored-by: Roland Stevenson <[email protected]>
Co-authored-by: Jeong-Yoon Lee <[email protected]>
Copy file name to clipboardexpand all lines: docs/installation.rst
+2-27
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
Installation
3
3
============
4
4
5
-
Installation with ``conda`` is recommended.
5
+
Installation with ``conda`` or ``pip`` is recommended. Developers can follow the **Install from source** instructions below. If building from source, consider doing so within a conda environment and then exporting the environment for reproducibility.
6
6
7
-
``conda`` environment files for Python 3.7, 3.8 and 3.9 are available in the repository. To use models under the ``inference.tf`` module (e.g. ``DragonNet``), additional dependency of ``tensorflow`` is required. For detailed instructions, see below.
7
+
To use models under the ``inference.tf`` module (e.g. ``DragonNet``), additional dependency of ``tensorflow`` is required. For detailed instructions, see below.
8
8
9
9
Install using ``conda``
10
10
-----------------------
@@ -29,31 +29,6 @@ Directly install from the ``conda-forge`` channel using ``conda``.
29
29
30
30
conda install -c conda-forge causalml
31
31
32
-
Install from the ``conda`` virtual environment
33
-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
34
-
35
-
This will create a new ``conda`` virtual environment named ``causalml-[tf-]py3x``, where ``x`` is in ``[7, 8, 9]``. e.g. ``causalml-py37`` or ``causalml-tf-py38``. If you want to change the name of the environment, update the relevant YAML file in ``envs/``.
36
-
37
-
Note: if you do not have the base cxx-compiler libraries installed, follow the ``Install from source`` instructions below to install them first.
38
-
39
-
.. code-block:: bash
40
-
41
-
git clone https://github.com/uber/causalml.git
42
-
cd causalml/envs/
43
-
conda env create -f environment-py38.yml # for the virtual environment with Python 3.8 and CausalML
44
-
conda activate causalml-py38
45
-
46
-
Install ``causalml`` with ``tensorflow``
47
-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
48
-
49
-
.. code-block:: bash
50
-
51
-
git clone https://github.com/uber/causalml.git
52
-
cd causalml/envs/
53
-
conda env create -f environment-tf-py38.yml # for the virtual environment with Python 3.8 and CausalML
54
-
conda activate causalml-tf-py38
55
-
pip install -U numpy # this step is necessary to fix [#338](https://github.com/uber/causalml/issues/338)
0 commit comments