Skip to content

Commit

Permalink
Update: add extra setup explanations
Browse files Browse the repository at this point in the history
  • Loading branch information
tiskw committed Nov 23, 2023
1 parent 547d532 commit f076f97
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 8 deletions.
16 changes: 12 additions & 4 deletions SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Setting Up
====================================================================================================


Installation
Environment setup
----------------------------------------------------------------------------------------------------

### Using Docker (recommended)
Expand All @@ -23,10 +23,10 @@ cd PATH_TO_THE_ROOT_DIRECTORY_OF_THIS_REPO
docker run --rm -it -v `pwd`:/work -w /work -u `id -u`:`id -g` tiskw/pytorch:latest bash
```

If you need GPU support, add `--gpus all` option to the above docker run command above.
If you need GPU support, add `--gpus all` option to the above `docker run` command above.
Also if the version of your docker is lower than 19, use `--runtime=nvidia` instead of `--gpus all`.

Also, if you want to use PyTorch 2.x, use `tiskw/pytorch2:latest` instead of `tiskw/pytorch2:latest`.
Also, if you want to use PyTorch 2.x, use `tiskw/pytorch2:latest` instead of `tiskw/pytorch:latest`.

### Installing on your environment (easier, but pollute your development environment)

Expand All @@ -38,6 +38,14 @@ pip3 install -r requirements.txt
```


Installation
----------------------------------------------------------------------------------------------------

Copy the `rfflearn` directory to your `PYTHONPATH`, or register the parent directory of `rfflearn`
to your `PYTHONPATH` by, for example, using `sys.path` variable. If you need a concrete example,
please refer [the sample code](/examples) that use the latter apporach.


Quick Tutorial
----------------------------------------------------------------------------------------------------

Expand Down Expand Up @@ -75,6 +83,6 @@ Next Step
----------------------------------------------------------------------------------------------------

Now you succeeded in installing the `rfflearn` module.
The author's recommendation for the next step is to see the [examples directory](./examples)
The author's recommendation for the next step is to see the [examples directory](/examples)
and try a code you are interested in.

8 changes: 4 additions & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ numpy>=1.19.0
scipy>=1.6.0
scikit-learn>=0.24.0

# Required for GPU training/inference
# Optional: Required for GPU training/inference
torch>=1.7.0

# Required for auto hyper parameter tuning
# Optional: Required for auto hyper parameter tuning
optuna>=2.3.0

# Required for feature importance calculation
# Optional: Required for feature importance calculation
shap>=0.37.0

# Required only for sample code
# Optional: Required only for the sample code
docopt>=0.6.0

0 comments on commit f076f97

Please # to comment.