Skip to content

Commit

Permalink
Add note about running tests
Browse files Browse the repository at this point in the history
  • Loading branch information
smokestacklightnin committed Aug 16, 2024
1 parent 7643665 commit f305a18
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ pip install tensorflow-transform
To build from source follow the following steps:
Create a virtual environment by running the commands

```
```bash
python3 -m venv <virtualenv_name>
source <virtualenv_name>/bin/activate
pip3 install setuptools wheel
Expand All @@ -53,13 +53,13 @@ pip3 install .

If you are doing development on the TFT repo, replace

```
```bash
pip3 install .
```

with

```
```bash
pip3 install -e .
```

Expand All @@ -78,6 +78,14 @@ pip install --extra-index-url https://pypi-nightly.tensorflow.org/simple tensorf
This will install the nightly packages for the major dependencies of TFT such
as TensorFlow Metadata (TFMD), TFX Basic Shared Libraries (TFX-BSL).

### Running Tests

To run TFT tests, run the following command from the root of the repository:

```bash
pytest
```

### Notable Dependencies

TensorFlow is required.
Expand Down

0 comments on commit f305a18

Please sign in to comment.