Skip to content
This repository has been archived by the owner on Jul 14, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
murphyk authored Mar 9, 2022
1 parent b11560c commit ceeef0f
Showing 1 changed file with 0 additions and 34 deletions.
34 changes: 0 additions & 34 deletions jsl/sent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,37 +29,3 @@ There are two different environment types which stand for the type of supervised
- Regression Environment

In order to use your own dataset,

1. You should define two functions which returns `x_train_generator` and `x_test_generator`, respectively. Both of them should look like

```
def make_x_sampler(input_dim: int):
def x_train_sampler(key: chex.PRNGKey, num_samples: int):
...
return X
return x_sampler
```

2. You should define sample_fn as follows:

```
def sample_fn(apply_fn: Callable,
x_generator: Callable,
num_train: int,
key: chex.PRNGKey):
x_train = x_generator(key, num_train)
y_train = ...
...
data = (x_train, y_train)
return data
```
Note that `apply_fn` is usually used for creating synthetic dataset.

## How to run

You can either create your own config file or use the predefined ones. Then, you should run

```
python3 -m jsl.gym_envs.run --config <path-of-config-file>
```

0 comments on commit ceeef0f

Please sign in to comment.