Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
- Added 3 tutorials and embended existing colab tutorial in it.
- Added 3 tutorials and embedded existing colab tutorial in it.
- Support artifacts for each optimizer based on evaluated trials.
- Add a generic structure for the filesystem writers.
- Add live_plots flag for run() API to print the generic and optimizer-specific plots
Expand Down
26 changes: 16 additions & 10 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,40 +1,46 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Stoll
given-names: Danny
- family-names: Alipour
given-names: Nastaran
- family-names: Mallik
given-names: Neeratyoy
- family-names: Bergman
given-names: Eddie
- family-names: Geburek
given-names: Anton Merlin
- family-names: Schrodi
given-names: Simon
- family-names: Basu
given-names: Soham
- family-names: Geburek
given-names: Anton Merlin
- family-names: Birinxhiku
given-names: Lum
- family-names: Abou Chakra
given-names: Tarek
- family-names: Garibov
given-names: Samir
- family-names: Gaur
given-names: Gopalji
- family-names: Alipour
given-names: Nastaran
- family-names: Janowski
given-names: Maciej
- family-names: Hvarfner
given-names: Carl
- family-names: Carstensen
given-names: Timur
- family-names: Mekic
given-names: Ema
- family-names: Ambattu
given-names: Philip Alex
- family-names: Rogalla
given-names: Daniel
- family-names: Hvarfner
given-names: Carl
- family-names: Binxin
given-names: Ru
- family-names: Carstensen
given-names: Timur
- family-names: Hog
given-names: Johannes
- family-names: Hutter
given-names: Frank
- family-names: Stoll
given-names: Danny
title: "Neural Pipeline Search (NePS)"
version: 0.16.0
date-released: 2025-04-11
Expand Down
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Automatic checks are run on every pull request and on every commit to `master`.

## Installation

There are four steps:
There are four steps:

1. Install uv
1. Clone the neps repository
Expand Down Expand Up @@ -211,6 +211,10 @@ To publish the documentation run
mike deploy 0.5.1 latest -p
```

## Tutorials

See [tutorials README](./tutorials/README.md).

## Releasing a New Version

There are four steps to releasing a new version of neps:
Expand Down Expand Up @@ -250,7 +254,7 @@ mike serve

and then looking at it.

Update the citations page.
Update the citation.cff page and citations.md page in the `docs` directory and in `pyproject.toml`.

Afterwards, publish it via

Expand Down
12 changes: 6 additions & 6 deletions docs/citations.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ For citing NePS, please refer to the following:
### APA Style

```apa
Stoll, D., Mallik, N., Bergman, E., Schrodi, S., Basu, S., Geburek, A. M., Abou Chakra, T., Garibov, S., Gaur, G., Alipour, N., Janowski, M., Hvarfner, C., Mekic, E., Carstensen, T., Rogalla, D., Ru, B., & Hutter, F. (2023). Neural Pipeline Search (NePS) (Version 0.12.2) [Computer software]. https://github.com/automl/neps
Nastaran A., Mallik, N., Bergman, E., Geburek, A. M., Schrodi, S., Basu, S., Birinxhiku, L., Abou Chakra, T., Garibov, S., Gaur, G., Alipour, N., Janowski, M., Hvarfner, C., Mekic, E., Carstensen, T., Rogalla, D., Ru, B., Hutter, F. & Stoll, D. (2026). Neural Pipeline Search (NePS) (Version 0.16.0) [Computer software]. https://github.com/automl/neps
```

### BibTex Style

```bibtex
@software{Stoll_Neural_Pipeline_Search_2023,
author = {Stoll, Danny and Mallik, Neeratyoy and Schrodi, Simon and Bergmann, Eddie and Janowski, Maciej and Garibov, Samir and Abou Chakra, Tarek and Rogalla, Daniel and Bergman, Eddie and Hvarfner, Carl and Binxin, Ru and Hutter, Frank},
month = oct,
@software{Stoll_Neural_Pipeline_Search_2026,
author = {Nastaran Alipour, Neeratyoy Mallik, Eddie Bergman, Anton Merlin Geburek, Simon Schrodi, Soham Basu, Lum Birinxhiku, Tarek Abou Chakra, Samir Garibov, Gopalji Gaur, Maciej Janowski, Ema Mekic, Philip Alex Ambattu, Daniel Rogalla, Carl Hvarfner, Binxin Ru, Timur Carstensen, Johannes Hog, Frank Hutter and Danny Stoll},
month = sep,
title = {{Neural Pipeline Search (NePS)}},
url = {https://github.com/automl/neps},
version = {0.12.2},
year = {2024}
version = {0.16.0},
year = {2026}
}
```

Expand Down
15 changes: 9 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,26 @@ name = "neural-pipeline-search"
version = "v0.16.0"
description = "Neural Pipeline Search helps deep learning experts find the best neural pipeline."
authors = [
{ name = "Danny Stoll", email = "stolld@cs.uni-freiburg.de" },
{ name = "Neeratyoy Mallik", email = "mallik@cs.uni-freiburg.de" },
{ name = "Nastaran Alipour", email = "alipourn@cs.uni-freiburg.de" },
{ name = "Neeratyoy Mallik"},
{ name = "Eddie Bergman" },
{ name = "Anton Merlin Geburek" },
{ name = "Simon Schrodi" },
{ name = "Soham Basu" },
{ name = "Anton Merlin Geburek" },
{ name = "Lum Birinxhiku" },
{ name = "Tarek Abou Chakra" },
{ name = "Samir Garibov" },
{ name = "Gopalji Gaur" },
{ name = "Nastaran Alipour", email = "mallik@cs.uni-freiburg.de" },
{ name = "Maciej Janowski" },
{ name = "Carl Hvarfner" },
{ name = "Timur Carstensen" },
{ name = "Ema Mekic" },
{ name = "Philip Alex Ambattu" },
{ name = "Daniel Rogalla" },
{ name = "Carl Hvarfner" },
{ name = "Binxin Ru" },
{ name = "Timur Carstensen" },
{ name = "Johannes Hog" },
{ name = "Frank Hutter" },
{ name = "Danny Stoll", email = "stolld@cs.uni-freiburg.de" },
]
readme = "README.md"
license = { file = "LICENSE" }
Expand Down
Loading
Loading