From 61a05cd64bfe9a3c74661d1cedb6b6f730920f94 Mon Sep 17 00:00:00 2001 From: FrAnCOisCokELaER Date: Wed, 28 Oct 2020 22:52:21 +0100 Subject: [PATCH 1/5] Add materials on how to setup dev env in CONTRIBUTING guide #1395 - first draft of first-time contributor guide --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 5f201a18e85e..38ba534c35dc 100644 --- a/README.md +++ b/README.md @@ -268,6 +268,42 @@ F1_mean.attach(engine, "F1") +# Quickstart guide for first-time contributors + +- Install [miniconda](https://docs.conda.io/projects/continuumio-conda/en/latest/user-guide/install/index.html) for your system. +- Create an isolated conda environment for pytorch-ignite: + ```bash +conda create -n pytorch-ignite-dev python=3 +``` + +- Activate the newly created environment: + ```bash +conda activate pytorch-ignite-dev +``` + +- Install the pytorch-ignite dependencies for development in this environment: +```bash +git clone https://github.com/pytorch/ignite.git +cd ignite +python setup.py develop +pip install -r requirements-dev.txt +pip install flake8 "black==19.10b0" "isort==4.3.21" "mypy==0.782" +``` + +- Import pytorch-ignite source project in your [IDE](https://www.jetbrains.com/help/pycharm/importing-project-from-existing-source-code.html). + +- Configure the conda environment in your IDE by adding an `Existing Environment`, here is the [documentation](https://www.jetbrains.com/help/pycharm/conda-support-creating-conda-virtual-environment.html) for PyCharm. + +- Once the project is fully configured, try to Run/Debug pytorch-ignite tests following [Pycharm pytest guide](https://www.jetbrains.com/help/pycharm/pytest.html) + +- When developing please take care of preserving `.gitignore` file and make use of `.git/info/exclude` to exclude custom files like: `.idea`, `.vscode` etc. + +- Please refer to [github first contributions guidelines](https://github.com/firstcontributions/first-contributions) and don't hesitate to ask the pytorch-ignite community in case of any doubt. + +- A good way to start is to tackle one of the [good first issues](https://github.com/pytorch/ignite/labels/good%20first%20issue). + + + # Installation From [pip](https://pypi.org/project/pytorch-ignite/): From c201e46c5135ef6d78925d12872413445312a8bc Mon Sep 17 00:00:00 2001 From: FrAnCOisCokELaER Date: Wed, 28 Oct 2020 22:54:50 +0100 Subject: [PATCH 2/5] Add materials on how to setup dev env in CONTRIBUTING guide #1395 - add in Table of Contents --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 38ba534c35dc..38f6fb1ba48a 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,7 @@ while ensuring maximum control and simplicity # Table of Contents - [Why Ignite?](#why-ignite) +- [Quickstart guide for first-time contributors](#quickstart) - [Installation](#installation) - [Getting Started](#getting-started) - [Documentation](#documentation) From c774c49cd06ed74551857ed7dfaef40024217011 Mon Sep 17 00:00:00 2001 From: FrAnCOisCokELaER Date: Wed, 28 Oct 2020 23:04:00 +0100 Subject: [PATCH 3/5] Add materials on how to setup dev env in CONTRIBUTING guide #1395 - fix table of contents link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38f6fb1ba48a..29d9025b64aa 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ while ensuring maximum control and simplicity # Table of Contents - [Why Ignite?](#why-ignite) -- [Quickstart guide for first-time contributors](#quickstart) +- [Quickstart guide for first-time contributors](#quickstart-guide-for-first-time-contributors) - [Installation](#installation) - [Getting Started](#getting-started) - [Documentation](#documentation) From fd12733c04e4f8a344797d816cf022f90e94e807 Mon Sep 17 00:00:00 2001 From: FrAnCOisCokELaER Date: Sat, 31 Oct 2020 08:49:02 +0100 Subject: [PATCH 4/5] Add materials on how to setup dev env in CONTRIBUTING guide #1395 - rollback README.md, remove IDE setting --- CONTRIBUTING.md | 19 ++++++++++++++++++- README.md | 37 ------------------------------------- 2 files changed, 18 insertions(+), 38 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d447a2714c5..d4a09a75250f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,24 @@ If you find a typo in the documentation, do not hesitate to submit a GitHub pull ## Developing Ignite +### Quickstart guide for first-time contributors + +- Install [miniconda](https://docs.conda.io/projects/continuumio-conda/en/latest/user-guide/install/index.html) for your system. +- Create an isolated conda environment for pytorch-ignite: + ```bash +conda create -n pytorch-ignite-dev python=3 +``` + +- Activate the newly created environment: + ```bash +conda activate pytorch-ignite-dev +``` + +- [Install](#installation) pytorch-ignite dependencies for development in this environment. +- When developing please take care of preserving `.gitignore` file and make use of `.git/info/exclude` to exclude custom files like: `.idea`, `.vscode` etc. +- Please refer to [github first contributions guidelines](https://github.com/firstcontributions/first-contributions) and don't hesitate to ask the pytorch-ignite community in case of any doubt. +- A good way to start is to tackle one of the [good first issues](https://github.com/pytorch/ignite/labels/good%20first%20issue). + ### Installation To get the development installation with the necessary dependencies, run the following: @@ -175,4 +193,3 @@ python -m http.server # python -m http.server 1234 ``` Then open the browser at `0.0.0.0:` (e.g. `0.0.0.0:1234`) and click to `html` folder. - diff --git a/README.md b/README.md index 70cf40f8b1b4..a68661bbe185 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,6 @@ while ensuring maximum control and simplicity # Table of Contents - [Why Ignite?](#why-ignite) -- [Quickstart guide for first-time contributors](#quickstart-guide-for-first-time-contributors) - [Installation](#installation) - [Getting Started](#getting-started) - [Documentation](#documentation) @@ -269,42 +268,6 @@ F1_mean.attach(engine, "F1") -# Quickstart guide for first-time contributors - -- Install [miniconda](https://docs.conda.io/projects/continuumio-conda/en/latest/user-guide/install/index.html) for your system. -- Create an isolated conda environment for pytorch-ignite: - ```bash -conda create -n pytorch-ignite-dev python=3 -``` - -- Activate the newly created environment: - ```bash -conda activate pytorch-ignite-dev -``` - -- Install the pytorch-ignite dependencies for development in this environment: -```bash -git clone https://github.com/pytorch/ignite.git -cd ignite -python setup.py develop -pip install -r requirements-dev.txt -pip install flake8 "black==19.10b0" "isort==4.3.21" "mypy==0.782" -``` - -- Import pytorch-ignite source project in your [IDE](https://www.jetbrains.com/help/pycharm/importing-project-from-existing-source-code.html). - -- Configure the conda environment in your IDE by adding an `Existing Environment`, here is the [documentation](https://www.jetbrains.com/help/pycharm/conda-support-creating-conda-virtual-environment.html) for PyCharm. - -- Once the project is fully configured, try to Run/Debug pytorch-ignite tests following [Pycharm pytest guide](https://www.jetbrains.com/help/pycharm/pytest.html) - -- When developing please take care of preserving `.gitignore` file and make use of `.git/info/exclude` to exclude custom files like: `.idea`, `.vscode` etc. - -- Please refer to [github first contributions guidelines](https://github.com/firstcontributions/first-contributions) and don't hesitate to ask the pytorch-ignite community in case of any doubt. - -- A good way to start is to tackle one of the [good first issues](https://github.com/pytorch/ignite/labels/good%20first%20issue). - - - # Installation From [pip](https://pypi.org/project/pytorch-ignite/): From 9f509864f812ffae5a1f2b5a971e001283430d76 Mon Sep 17 00:00:00 2001 From: vfdev Date: Sat, 31 Oct 2020 13:29:52 +0100 Subject: [PATCH 5/5] Update CONTRIBUTING.md --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d4a09a75250f..73115ac76cf4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,6 +31,10 @@ If you find a typo in the documentation, do not hesitate to submit a GitHub pull ### Quickstart guide for first-time contributors + + +
+ - Install [miniconda](https://docs.conda.io/projects/continuumio-conda/en/latest/user-guide/install/index.html) for your system. - Create an isolated conda environment for pytorch-ignite: ```bash @@ -42,11 +46,14 @@ conda create -n pytorch-ignite-dev python=3 conda activate pytorch-ignite-dev ``` -- [Install](#installation) pytorch-ignite dependencies for development in this environment. - When developing please take care of preserving `.gitignore` file and make use of `.git/info/exclude` to exclude custom files like: `.idea`, `.vscode` etc. - Please refer to [github first contributions guidelines](https://github.com/firstcontributions/first-contributions) and don't hesitate to ask the pytorch-ignite community in case of any doubt. - A good way to start is to tackle one of the [good first issues](https://github.com/pytorch/ignite/labels/good%20first%20issue). +
+ + + ### Installation To get the development installation with the necessary dependencies, run the following: