Skip to content

Commit

Permalink
Merge pull request #195 from kta-intel/kta-intel/update-README
Browse files Browse the repository at this point in the history
update README to help resolve or troubleshoot common issues during installation
  • Loading branch information
sarthakpati authored Jun 17, 2024
2 parents 4590b7e + 4353519 commit 8265fff
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions Task_1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Please ask any additional questions in our discussion pages on our github site a
2. [Git LFS](https://github.com/git-lfs/git-lfs#downloading)
2. Python with virtual environment management system: we recommend using [Anaconda](https://www.anaconda.com/products/individual).
3. **Windows- Only**: Pickle5 requires Microsoft C++ 14.0 or greater from the [C++ build tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
> * _Note: if you run into ```UnicodeDecodeError``` during installation, trying pinning ```openfl @ git+https://github.com/intel/[email protected]``` in [setup.py](https://github.com/FeTS-AI/Challenge/blob/main/Task_1/setup.py#L31)_
4. Use CUDA 11 for your installation as CUDA 12 is not compatible with this codebase.

### Instructions
Expand All @@ -27,10 +28,12 @@ conda activate ./venv
```
6. ```pip install --upgrade pip```
7. Install Pytorch LTS (1.8.2) for your system using [these instructions](https://pytorch.org/get-started/locally/)
8. ```pip install .```
9. ```python FeTS_Challenge.py```
10. All lower-level details are in the [FeTS Challenge python file](./FeTS_Challenge.py)
11. To view intermediate results with TensorBoard during training, you can run the following command:
8. Set the environment variable `SKLEARN_ALLOW_DEPRECATED_SKLEARN_PACKAGE_INSTALL=True` (to avoid sklearn deprecation error)
9. ```pip install .```
> * _Note: if you run into ```ERROR: Failed building wheel for SimpleITK```, try running ```pip install SimpleITK --only-binary :all:``` then rerunning ```pip install .```_
10. ```python FeTS_Challenge.py```
11. All lower-level details are in the [FeTS Challenge python file](./FeTS_Challenge.py)
12. To view intermediate results with TensorBoard during training, you can run the following command:
```tensorboard --logdir ~/.local/workspace/logs/tensorboard```

## Time to Convergence Metric (formerly "communication cost")
Expand Down

0 comments on commit 8265fff

Please sign in to comment.