From b3119f3b28b18b7995524759e7f5b92b5dc15beb Mon Sep 17 00:00:00 2001 From: ras44 <9282281+ras44@users.noreply.github.com> Date: Wed, 12 Jul 2023 18:56:01 +0200 Subject: [PATCH] Remove $ prefix in README.md examples --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 6c3cbf15..8a3f4043 100644 --- a/README.md +++ b/README.md @@ -72,47 +72,47 @@ source ~/.bashrc Directly install from the conda-forge channel using conda. ```sh -$ conda install -c conda-forge causalml +conda install -c conda-forge causalml ``` ### Install with the `conda` virtual environment This will create a new `conda` virtual environment named `causalml-[tf-]py3x`, where `x` is in `[6, 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/` ```bash -$ git clone https://github.com/uber/causalml.git -$ cd causalml/envs/ -$ conda env create -f environment-py38.yml # for the virtual environment with Python 3.8 and CausalML -$ conda activate causalml-py38 +git clone https://github.com/uber/causalml.git +cd causalml/envs/ +conda env create -f environment-py38.yml # for the virtual environment with Python 3.8 and CausalML +conda activate causalml-py38 (causalml-py38) ``` ### Install `causalml` with `tensorflow` ```bash -$ git clone https://github.com/uber/causalml.git -$ cd causalml/envs/ -$ conda env create -f environment-tf-py38.yml # for the virtual environment with Python 3.8 and CausalML -$ conda activate causalml-tf-py38 +git clone https://github.com/uber/causalml.git +cd causalml/envs/ +conda env create -f environment-tf-py38.yml # for the virtual environment with Python 3.8 and CausalML +conda activate causalml-tf-py38 (causalml-tf-py38) pip install -U numpy # this step is necessary to fix [#338](https://github.com/uber/causalml/issues/338) ``` ## Install from `PyPI`: ```bash -$ pip install causalml +pip install causalml ``` ### Install `causalml` with `tensorflow` ```bash -$ pip install causalml[tf] -$ pip install -U numpy # this step is necessary to fix [#338](https://github.com/uber/causalml/issues/338) +pip install causalml[tf] +pip install -U numpy # this step is necessary to fix [#338](https://github.com/uber/causalml/issues/338) ``` ## Install from source: ```bash -$ git clone https://github.com/uber/causalml.git -$ cd causalml -$ pip install . +git clone https://github.com/uber/causalml.git +cd causalml +pip install . ``` with `tensorflow`: ```bash