diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..36636d2a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,20 @@ +--- +name: Bug Report +about: Create a bug report to help us improve +title: "[BUG]: " +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behaviour. + +**Expected behaviour** +A clear and concise description of what you expected to happen. + +**Additional context** +Add any other context about the problem here, including any relevant system information and python version. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..0075ccb7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,20 @@ +--- +name: Bug report +about: Create a bug report to help us improve +title: "[BUG]" +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behaviour. + +**Expected behaviour** +A clear and concise description of what you expected to happen. + +**Additional context** +Add any other context about the problem here, including any relevant system information and python version. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..5bbb680f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,20 @@ +--- +name: Feature Request +about: Suggest an idea for this project +title: "[FEATURE]: " +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..f4558654 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEATURE]" +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/framework-request.md b/.github/ISSUE_TEMPLATE/framework-request.md new file mode 100644 index 00000000..b6abcc31 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/framework-request.md @@ -0,0 +1,27 @@ +--- +name: Framework Request +about: Suggest for a new framework to be added to this project +title: "[FRAMEWORK]: " +labels: enhancement +assignees: '' + +--- + +**Which framework would you like added to this project** +- framework name +- link to academic paper + +**Why should this framework be added?** +What benefit is there to adding this framework? + +**Short summary of framework** +What is the core algorithmic idea behind the framework in simple terms. Please give a general overview rather than advanced algorithmic concepts. +- eg. The beta-VAE weights the regularisation term, aiming to improve disentanglement. +- e.g The DFC-VAE augments the reconstruction loss of the VAE/beta-VAE with a perceptual loss. + +**Which framework does this build upon, if any?** +eg. the beta-VAE extends the standard VAE +eg. the Adaptive VAEs extend the beta-VAE + +**Are you willing to submit a PR?** +Are you willing to work on this implementation and submit a PR? diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..c77a96ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,13 @@ +--- +name: Question +about: Ask a question about this project +title: "[Q]: " +labels: question +assignees: '' + +--- + +**Ask Away!** + +- Please double check the [docs](https://disent.dontpanic.sh) to make sure that your question is not already answered there. +- Please double check the issues to make sure that your question has not been answered before.