Skip to content

Commit ebd89c4

Browse files
Updated citation (#27, #28)
Co-authored-by: eddiebergman <[email protected]>
1 parent 5811bf9 commit ebd89c4

File tree

2 files changed

+45
-2
lines changed

2 files changed

+45
-2
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,29 @@ You can find more arguments and information (like using custom configurations) i
9090
[documentation](https://automl.github.io/DeepCAVE/main/getting_started.html).
9191

9292

93+
## Example runs
94+
95+
DeepCAVE comes with some pre-evaluated runs to get a feel for what DeepCAVE can do.
96+
97+
When you installed the package from GitHub via `git clone [email protected]:automl/DeepCAVE.git; pip install -e DeepCAVE`,
98+
you can try out some examples by exploring the `logs` directory inside the DeepCAVE dashboard.
99+
For example, if you navigate to `logs/DeepCAVE`, you can view the run `mnist_pytorch` if you hit
100+
the `+` button.
101+
102+
93103
## Citation
94104

95-
Currently, DeepCAVE is under review.
105+
If you use DeepCAVE in one of your research projects, please cite our [ReALML@ICML'22 workshop paper](https://arxiv.org/abs/2206.03493):
106+
```
107+
@misc{sass-realml2022,
108+
title = {DeepCAVE: An Interactive Analysis Tool for Automated Machine Learning},
109+
author = {Sass, René and Bergman, Eddie and Biedenkapp, André and Hutter, Frank and Lindauer, Marius},
110+
doi = {10.48550/ARXIV.2206.03493},
111+
url = {https://arxiv.org/abs/2206.03493},
112+
publisher = {arXiv},
113+
year = {2022},
114+
copyright = {arXiv.org perpetual, non-exclusive license}
115+
}
116+
```
117+
118+
Copyright (C) 2016-2022 [AutoML Group](http://www.automl.org/).

docs/index.rst

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,24 @@ Features
4141
- Help buttons and integrated documentation in the interface helps you to understand the plugins.
4242
- Use the matplotlib mode to customize and save the plots for your publication.
4343
- The API mode gives you full access to the code, while you do not have to interact with the
44-
interface. Otherwise, you can also make use of the raw data, provided by every plugin.
44+
interface. Otherwise, you can also make use of the raw data, provided by every plugin.
45+
46+
47+
48+
Citation
49+
^^^^^^^^
50+
51+
If you use DeepCAVE in one of your research projects, please cite our `ReALML@ICML'22 workshop paper <https://arxiv.org/abs/2206.03493>`_:
52+
53+
.. code-block:: text
54+
55+
@misc{sass-realml2022,
56+
title = {DeepCAVE: An Interactive Analysis Tool for Automated Machine Learning},
57+
author = {Sass, René and Bergman, Eddie and Biedenkapp, André and Hutter, Frank and Lindauer, Marius},
58+
doi = {10.48550/ARXIV.2206.03493},
59+
url = {https://arxiv.org/abs/2206.03493},
60+
publisher = {arXiv},
61+
year = {2022},
62+
copyright = {arXiv.org perpetual, non-exclusive license}
63+
}
64+

0 commit comments

Comments
 (0)