Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update doc to point to contribution guide #463

Merged
merged 2 commits into from Nov 15, 2018
Merged

update doc to point to contribution guide #463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d2896c
update doc to point to contribution guide
KEggensperger Nov 15, 2018
d8282eb
add a link to contrib guide
KEggensperger Nov 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Expand Up @@ -105,4 +105,6 @@ See examples/

SMAC3 is developed by the [AutoML Group of the University of Freiburg](http://www.automl.org/).

If you found a bug, please report to https://github.com/automl/SMAC3
If you found a bug, please report to <https://github.com/automl/SMAC3/issues>.

Our guidelines for contributing to this package can be found [here](https://github.com/automl/SMAC3/blob/master/.github/CONTRIBUTING.md)
26 changes: 18 additions & 8 deletions doc/faq.rst
View file
Open in desktop
Expand Up @@ -24,14 +24,25 @@ You can also run SMAC with :code:`--verbose DEBUG` to see how *SMAC* tried to ca

Use the `restore-option <basic_usage.html#restorestate>`_.

.. rubric:: I discovered a bug/have criticism or ideas on *SMAC*. Where should I report to?
.. rubric:: I discovered a bug or SMAC does not behave as expected. Where should I report to?

*SMAC* uses the
`GitHub issue-tracker <https://github.com/automl/SMAC3/issues>`_ to take care
of bugs and questions. If you experience problems with *SMAC*, try to provide
a full error report with all the typical information (OS, version,
console-output, minimum working example, ...). This makes it a lot easier to
reproduce the error and locate the problem.
Open an issue in our issue list on GitHub. Before you report a bug, please make sure that:

* Your bug hasn't already been reported in our issue tracker
* You are using the latest SMAC3 version.

If you found an issue, please provide us with the following information:

* A description of the problem
* An example to reproduce the problem
* Any information about your setup that could be helpful to resolve the bug (such as installed python packages)
* Feel free, to add a screenshot showing the issue

.. rubric:: I want to contribute code or discuss a new idea. Where should I report to?

*SMAC* uses the `GitHub issue-tracker <https://github.com/automl/SMAC3/issues>`_ to also take care
of questions and feedback and is the preferred location for discussing new features and ongoing work. Please also have a look at our
`contribution guide <https://github.com/automl/SMAC3/blob/master/.github/CONTRIBUTING.md>`_.

.. rubric:: What is the meaning of *deterministic*?

Expand All @@ -41,7 +52,6 @@ to determine the performance of that configuration on one instance.
Deterministic algorithms don't depend on seeds, thus requiring only one evaluation of a configuration on an instance
to evaluate the performance on that instance. Nevertheless the default seed 0 is still passed to the target algorithm.


.. rubric:: **Glossary**

* **SMAC**: Sequential Model-Based Algorithm Configuration
Expand Down