Skip to content

Commit

Permalink
update developer readme instruction on python env creation
Browse files Browse the repository at this point in the history
  • Loading branch information
serena-ruan committed Oct 25, 2022
1 parent 467e651 commit 6d11c0d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
8 changes: 7 additions & 1 deletion website/docs/reference/developer-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ description: SynapseML Development Setup
- Install [Miniconda](https://docs.conda.io/en/latest/miniconda.html)
- Note: if you want to run conda commands from IntelliJ, you may need to select the option to add conda to PATH during installation.
- Activate the `synapseml` conda environment by running `conda env create -f environment.yml` from the `synapseml` directory.
:::note
If you're using a Windows machine, please remove
`horovod==0.25.0` requirement in the environment.yml file, because horovod installation only
supports Linux or macOS. Horovod is used only for namespace `synapse.ml.dl`.
:::
1. Install pre-commit
- This repository uses the [pre-commit](https://pre-commit.com/index.html) tool to manage git hooks and enforce linting/coding styles.
- The hooks are configured in [.pre-commit-config.yaml](https://github.com/microsoft/SynapseML/blob/master/environment.yml).
Expand Down Expand Up @@ -77,7 +82,8 @@ Generates documentation for scala sources
### `createCondaEnv`
Creates a conda environment `synapseml` from `environment.yml` if it does not already exist.
This env is used for python testing. **Activate this env before using python build commands.**
This env is used for python testing.
**Activate this env before using python build commands.**
### `cleanCondaEnv`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ description: SynapseML Development Setup
- Install [Miniconda](https://docs.conda.io/en/latest/miniconda.html)
- Note: if you want to run conda commands from IntelliJ, you may need to select the option to add conda to PATH during installation.
- Activate the `synapseml` conda environment by running `conda env create -f environment.yml` from the `synapseml` directory.
:::note
If you're using a Windows machine, please remove
`horovod==0.25.0` requirement in the environment.yml file, because horovod installation only
supports Linux or macOS. Horovod is used only for namespace `synapse.ml.dl`.
:::
1. Install pre-commit
- This repository uses the [pre-commit](https://pre-commit.com/index.html) tool to manage git hooks and enforce linting/coding styles.
- The hooks are configured in [.pre-commit-config.yaml](https://github.com/microsoft/SynapseML/blob/master/environment.yml).
Expand Down

0 comments on commit 6d11c0d

Please sign in to comment.