Clarify recommended SB usage and no tech support (#377)

* Clarify recommended SB usage
+ no tech support

* Doc fix

* Bump version

* Update issue template

* Update issue-template.md

.github/ISSUE_TEMPLATE/issue-template.md

@@ -4,16 +4,31 @@ about: How to create an issue for this repository
 
 ---
 
+**Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email.
+
 If you have any questions, feel free to create an issue with the tag [question].  
 If you wish to suggest an enhancement or feature request, add the tag [feature request].  
-If you are submitting a bug report, please fill in the following details.  
+If you are submitting a bug report, please fill in the following details.
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **Code example**
 Please try to provide a minimal example to reproduce the bug. Error messages and stack traces are also helpful.
 
+Please use the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks)
+for both code and stack traces.
+
+```python
+from stable_baselines import ...
+
+```
+
+```bash
+Traceback (most recent call last): File ...
+
+```
+
 **System Info**
 Describe the characteristic of your environment:
  * Describe how the library was installed (pip, docker, source, ...)

README.md

@@ -11,6 +11,8 @@ You can read a detailed presentation of Stable Baselines in the [Medium article]
 
 These algorithms will make it easier for the research community and industry to replicate, refine, and identify new ideas, and will create good baselines to build projects on top of. We expect these tools will be used as a base around which new ideas can be added, and as a tool for comparing a new approach against existing ones. We also hope that the simplicity of these tools will allow beginners to experiment with a more advanced toolset, without being buried in implementation details.
 
+**Note: despite its simplicity of use, Stable Baselines (SB) assumes you have some knowledge about Reinforcement Learning (RL).** You should not utilize this library without some practice. To that extent, we provide good resources in the [documentation](https://stable-baselines.readthedocs.io/en/master/guide/rl.html) to get started with RL.
+
 ## Main differences with OpenAI Baselines
 
 This toolset is a fork of OpenAI Baselines, with a major structural refactoring, and code cleanups:
@@ -205,6 +207,9 @@ To cite this repository in publications:
 
 Stable-Baselines is currently maintained by [Ashley Hill](https://github.com/hill-a) (aka @hill-a), [Antonin Raffin](https://araffin.github.io/) (aka [@araffin](https://github.com/araffin)), [Maximilian Ernestus](https://github.com/erniejunior) (aka @erniejunior) and [Adam Gleave](https://github.com/adamgleave) (@AdamGleave).
 
+**Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email.
+
+
 ## How To Contribute
 
 To any interested in making the baselines better, there is still some documentation that needs to be done.

docs/guide/rl_zoo.rst

@@ -92,7 +92,7 @@ with a budget of 1000 trials and a maximum of 50000 steps:
 
 ::
 
-  python -m train.py --algo ppo2 --env MountainCar-v0 -n 50000 -optimize --n-trials 1000 --n-jobs 2 \
+  python train.py --algo ppo2 --env MountainCar-v0 -n 50000 -optimize --n-trials 1000 --n-jobs 2 \
     --sampler random --pruner median
 
 

docs/misc/changelog.rst

@@ -6,6 +6,31 @@ Changelog
 For download links, please look at `Github release page <https://github.com/hill-a/stable-baselines/releases>`_.
 
 
+Pre-Release 2.6.1a0 (WIP)
+--------------------------
+
+Breaking Changes:
+^^^^^^^^^^^^^^^^^
+
+New Features:
+^^^^^^^^^^^^^
+
+Bug Fixes:
+^^^^^^^^^^
+
+Deprecations:
+^^^^^^^^^^^^^
+
+Others:
+^^^^^^^
+
+Documentation:
+^^^^^^^^^^^^^^
+
+- doc fix for the hyperparameter tuning command in the rl zoo
+
+
+
 Release 2.6.0 (2019-06-12)
 --------------------------
 

setup.py

@@ -137,7 +137,7 @@
       license="MIT",
       long_description=long_description,
       long_description_content_type='text/markdown',
-      version="2.6.0",
+      version="2.6.1a0",
       )
 
 # python setup.py sdist

stable_baselines/__init__.py

@@ -10,4 +10,4 @@
 from stable_baselines.trpo_mpi import TRPO
 from stable_baselines.sac import SAC
 
-__version__ = "2.6.0"
+__version__ = "2.6.1a0"