Skip to content

Commit

Permalink
Project import generated by Copybara.
Browse files Browse the repository at this point in the history
GitOrigin-RevId: f3b89f5cc28b7c3afc3209fa2b464c2b46274839
  • Loading branch information
Gretel Team authored and mckornfield committed Oct 7, 2024
1 parent ff033ea commit 54718c1
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
- [Train your model](https://gretel-synthetics.readthedocs.io/en/stable/api/train.html)
- [Generate synthetic records](https://gretel-synthetics.readthedocs.io/en/stable/api/generate.html)

## Try it out now!
## Try it out now

If you want to quickly discover gretel-synthetics, simply click the button below and follow the tutorials!

Expand All @@ -37,14 +37,14 @@ This section will guide you through installation of `gretel-synthetics` and depe
By default, we do not install certain core requirements, the following dependencies should be installed _external to the installation_
of `gretel-synthetics`, depending on which model(s) you plan to use.

- Tensorflow: Used by the LSTM model, we recommend version 2.11.x
- Tensorflow: Used by the LSTM model, we recommend version 2.12.x
- Torch: Used by Timeseries DGAN and ACTGAN (for ACTGAN, Torch is installed by SDV), we recommend version 2.0
- SDV (Synthetic Data Vault): Used by ACTGAN, we recommend version 0.17.x

These dependencies can be installed by doing the following:

```
pip install tensorflow==2.11 # for LSTM
pip install tensorflow==2.12.1 # for LSTM
pip install sdv<0.18 # for ACTGAN
pip install torch==2.0 # for Timeseries DGAN
```
Expand All @@ -64,8 +64,8 @@ pip install gretel-synthetics
_then..._

```
$ pip install jupyter
$ jupyter notebook
pip install jupyter
jupyter notebook
```

When the UI launches in your browser, navigate to `examples/synthetic_records.ipynb` and get generating!
Expand All @@ -75,13 +75,13 @@ If you want to install `gretel-synthetics` locally and use a GPU (recommended):
1. Create a virtual environment (e.g. using `conda`)

```
$ conda create --name tf python=3.9
conda create --name tf python=3.9
```

2. Activate the virtual environment

```
$ conda activate tf
conda activate tf
```

3. Run the setup script `./setup-utils/setup-gretel-synthetics-tensorflow24-with-gpu.sh`
Expand Down
2 changes: 1 addition & 1 deletion requirements/base.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
category-encoders==2.2.2
joblib==1.4.2
numpy>=1.18.0,<1.24
packaging==21.3
packaging==24.1
pandas>=1.1.0,<2
rdt>=1.2,<1.3
sdv>=0.17,<0.18
Expand Down
2 changes: 1 addition & 1 deletion requirements/tensorflow.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
protobuf>=3.9.2,<3.20
protobuf>=4,<=4.24.0
tensorflow==2.12.1
tensorflow_estimator==2.12.0
tensorflow_privacy==0.7.3
Expand Down

0 comments on commit 54718c1

Please sign in to comment.