Skip to content

Commit b34236c

Browse files
committed
Adding license badge and citation paragraph
1 parent 6898404 commit b34236c

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

README.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,39 @@
1-
# Material for this tutorial
1+
# Tutorial on introduction to Bayesian optimization
2+
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
3+
4+
- [Download the repository](#download-the-repository)
5+
- [Getting started](#getting-started)
6+
- [Running the tutorial](#running-the-tutorial)
7+
8+
## Material for this tutorial
29
- The theoretical lecture can be found here
310
- The tutorial in slide form is here
411

5-
# Installation instructions
12+
## Download the repository
613

7-
## Get the repository with Git
14+
### Get the repository with Git
815
You will need to have Git previously installed in your computer.
916
To check if you have it installed, open your terminal and type:
1017

1118
``` bash
1219
git --version
1320
```
1421

15-
### Git installation in mac
22+
#### Git installation in mac
1623

1724
``` bash
1825
brew update
1926
brew install git
2027
```
2128

22-
### Git installation in linux
23-
#### Ubuntu/Debian
29+
#### Git installation in linux
30+
In Ubuntu/Debian
2431

2532
``` bash
2633
sudo apt install git
2734
```
2835

29-
#### CentOS
36+
In CentOS
3037

3138
``` bash
3239
sudo yum install git
@@ -38,15 +45,15 @@ git clone https://github.com/machine-learning-tutorial/bayesian-optimization.git
3845
cd bayesian-optimization
3946
```
4047

41-
## Get the repository with direct download
48+
### Get the repository with direct download
4249
Open your terminal, go to your desired directory, and type:
4350
``` bash
4451
wget https://github.com/machine-learning-tutorial/bayesian-optimization/archive/refs/heads/main.zip
4552
unzip main.zip
4653
cd bayesian-optimization
4754
```
4855

49-
## Install required libraries in a virtual environment
56+
## Getting started
5057
You need to install the dependencies before running the notebooks.
5158

5259
### Using conda
@@ -88,3 +95,10 @@ jupyter lab
8895
```
8996

9097
Alternatively, you can use supported Editor to run the jupyter notebooks, e.g. with VS Code.
98+
99+
## Citing the tutorial
100+
This tutorial is registered [Zenodo](https://zenodo.org/), which means that there is a DOI for each code release.
101+
Please use this DOI when citing this code:
102+
103+
## Disclaimer
104+
The content of this repository was developed by the [AI4Accelerators team](https://www.ibpt.kit.edu/AI4Accelerators.php) at the [Institute of Beam Physics and Technology (IBPT)](https://www.ibpt.kit.edu/), [Karlsruhe Institute of Technology](https://www.kit.edu/english/).

0 commit comments

Comments
 (0)