Skip to content

Commit

Permalink
Remove $ prefix in README.md examples
Browse files Browse the repository at this point in the history
  • Loading branch information
ras44 committed Jul 12, 2023
1 parent f86a7c0 commit b3119f3
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b3119f3

Please sign in to comment.