neural-pipeline-search

Neural Pipeline Search (NePS): Helps deep learning experts find the best neural pipeline.

https://github.com/automl/neps

Science Score: 64.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: arxiv.org
  • Committers with academic emails
    8 of 23 committers (34.8%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.2%) to scientific vocabulary

Keywords

automl deep-learning hyperparameter-optimization neural-architecture-search neural-pipeline-search

Keywords from Contributors

optimizer benchmarking generic interactive mesh interpretability sequences datascience projection embedded
Last synced: 4 months ago · JSON representation ·

Repository

Neural Pipeline Search (NePS): Helps deep learning experts find the best neural pipeline.

Basic Info
Statistics
  • Stars: 77
  • Watchers: 8
  • Forks: 19
  • Open Issues: 20
  • Releases: 0
Topics
automl deep-learning hyperparameter-optimization neural-architecture-search neural-pipeline-search
Created over 4 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing License Citation

README.md

Neural Pipeline Search (NePS)

PyPI version Python versions License Tests

Welcome to NePS, a powerful and flexible Python library for hyperparameter optimization (HPO) and neural architecture search (NAS) that makes HPO and NAS practical for deep learners.

NePS houses recently published and also well-established algorithms that can all be run massively parallel on distributed setups and, in general, NePS is tailored to the needs of deep learning experts.

To learn about NePS, check-out the documentation, our examples, or a colab tutorial.

Key Features

In addition to the features offered by traditional HPO and NAS libraries, NePS stands out with:

  1. Hyperparameter Optimization (HPO) Efficient Enough for Deep Learning:
    NePS excels in efficiently tuning hyperparameters using algorithms that enable users to make use of their prior knowledge, while also using many other efficiency boosters.
  2. Neural Architecture Search (NAS) with Expressive Search Spaces:
    NePS provides capabilities for optimizing DL architectures in an expressive and natural fashion.
  3. Zero-effort Parallelization and an Experience Tailored to DL:
    NePS simplifies the process of parallelizing optimization tasks both on individual computers and in distributed computing environments. As NePS is made for deep learners, all technical choices are made with DL in mind and common DL tools such as Tensorboard are embraced.

Installation

To install the latest release from PyPI run

bash pip install neural-pipeline-search

Basic Usage

Using neps always follows the same pattern:

  1. Define a evaluate_pipeline function capable of evaluating different architectural and/or hyperparameter configurations for your problem.
  2. Define a search space named pipeline_space of those Parameters e.g. via a dictionary
  3. Call neps.run(evaluate_pipeline, pipeline_space)

In code, the usage pattern can look like this:

```python import neps import logging

logging.basicConfig(level=logging.INFO)

1. Define a function that accepts hyperparameters and computes the validation error

def evaluate_pipeline(lr: float, alpha: int, optimizer: str) -> float: # Create your model model = MyModel(lr=lr, alpha=alpha, optimizer=optimizer)

# Train and evaluate the model with your training pipeline
validation_error = train_and_eval(model)
return validation_error

2. Define a search space of parameters; use the same parameter names as in evaluate_pipeline

pipeline_space = dict( lr=neps.Float( lower=1e-5, upper=1e-1, log=True, # Log spaces prior=1e-3, # Incorporate you knowledge to help optimization ), alpha=neps.Integer(lower=1, upper=42), optimizer=neps.Categorical(choices=["sgd", "adam"]) )

3. Run the NePS optimization

neps.run( evaluatepipeline=evaluatepipeline, pipelinespace=pipelinespace, rootdirectory="path/to/save/results", # Replace with the actual path. evaluationsto_spend=100, ) ```

Examples

Discover how NePS works through these examples:

Contributing

Please see the documentation for contributors.

Citations

For pointers on citing the NePS package and papers refer to our documentation on citations.

Owner

  • Name: AutoML-Freiburg-Hannover
  • Login: automl
  • Kind: organization
  • Location: Freiburg and Hannover, Germany

Citation (CITATION.cff)

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: Mallik
    given-names: Neeratyoy
  - family-names: Bergman
    given-names: Eddie
  - family-names: Schrodi
    given-names: Simon
  - family-names: Garibov
    given-names: Samir
  - family-names: Abou Chakra
    given-names: Tarek
  - family-names: Carstensen
    given-names: Timur
  - family-names: Janowski
    given-names: Maciej
  - family-names: Gaur
    given-names: Gopalji
  - family-names: Geburek
    given-names: Anton Merlin
  - family-names: Rogalla
    given-names: Daniel
  - family-names: Hvarfner
    given-names: Carl
  - family-names: Binxin
    given-names: Ru
  - family-names: Hutter
    given-names: Frank
title: "Neural Pipeline Search (NePS)"
version: 0.13.0
date-released: 2025-04-11
url: "https://github.com/automl/neps"

GitHub Events

Total
  • Create event: 67
  • Issues event: 61
  • Watch event: 25
  • Delete event: 28
  • Issue comment event: 71
  • Member event: 7
  • Push event: 361
  • Pull request review comment event: 52
  • Pull request review event: 40
  • Pull request event: 112
  • Fork event: 6
Last Year
  • Create event: 67
  • Issues event: 61
  • Watch event: 25
  • Delete event: 28
  • Issue comment event: 71
  • Member event: 7
  • Push event: 361
  • Pull request review comment event: 52
  • Pull request review event: 40
  • Pull request event: 112
  • Fork event: 6

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 1,446
  • Total Committers: 23
  • Avg Commits per committer: 62.87
  • Development Distribution Score (DDS): 0.694
Past Year
  • Commits: 144
  • Committers: 12
  • Avg Commits per committer: 12.0
  • Development Distribution Score (DDS): 0.688
Top Committers
Name Email Commits
Danny Stoll s****d@c****e 443
schrodi s****i@c****e 230
neeratyoy n****y@g****m 160
Daniel 6****l 117
worstseed m****i@g****m 116
eddiebergman e****s@g****m 92
Tarek Abou Chakra t****a@h****m 70
Meganton a****n@g****m 45
Carl Hvarfner c****r@l****e 42
karibbov k****v@g****m 36
Theophane Vallaeys w****n@g****m 23
Nils Kober n****r@s****e 16
Sohambasu07 s****7@g****m 15
Gopalji Gaur g****g@c****e 9
robin r****n@r****k 7
Timur M. Carstensen 4****n 5
Jan Oreans o****j@c****e 5
dependabot[bot] 4****] 4
Gopalji Gaur g****r@g****m 3
Neeratyoy Mallik m****k@t****e 3
Lum Birinxhiku 8****b 2
Samir Garibov g****s@i****e 2
herilalaina r****a@g****m 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 94
  • Total pull requests: 189
  • Average time to close issues: 7 months
  • Average time to close pull requests: 23 days
  • Total issue authors: 14
  • Total pull request authors: 15
  • Average comments per issue: 0.95
  • Average comments per pull request: 0.57
  • Merged pull requests: 137
  • Bot issues: 0
  • Bot pull requests: 14
Past Year
  • Issues: 18
  • Pull requests: 110
  • Average time to close issues: 20 days
  • Average time to close pull requests: 11 days
  • Issue authors: 6
  • Pull request authors: 14
  • Average comments per issue: 0.44
  • Average comments per pull request: 0.47
  • Merged pull requests: 79
  • Bot issues: 0
  • Bot pull requests: 6
Top Authors
Issue Authors
  • eddiebergman (38)
  • danrgll (27)
  • Sohambasu07 (6)
  • timurcarstensen (4)
  • Meganton (4)
  • nabenabe0928 (3)
  • TarekAbouChakra (3)
  • Neeratyoy (3)
  • AwePhD (3)
  • bastis007 (1)
  • karibbov (1)
  • simon-ging (1)
  • Alken0 (1)
  • nastaran78 (1)
  • gopaljigaur (1)
Pull Request Authors
  • eddiebergman (85)
  • danrgll (26)
  • Meganton (24)
  • Neeratyoy (15)
  • timurcarstensen (15)
  • dependabot[bot] (14)
  • gopaljigaur (12)
  • TarekAbouChakra (8)
  • Sohambasu07 (7)
  • vladislavalerievich (3)
  • AnushaChatto (2)
  • nastaran78 (2)
  • karibbov (2)
  • lumib (1)
  • emaMekic (1)
Top Labels
Issue Labels
bug (14) enhancement (10) documentation (9) ux (8) question (6) ci (4) dependencies (1) known issue (1) help wanted (1) good first issue (1) wontfix (1)
Pull Request Labels
dependencies (17) enhancement (14) documentation (5) ci (5) ux (5) good first issue (5) github_actions (3) optim (2) known issue (2) help wanted (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 160 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 17
  • Total maintainers: 3
pypi.org: neural-pipeline-search

Neural Pipeline Search helps deep learning experts find the best neural pipeline.

  • Documentation: https://neural-pipeline-search.readthedocs.io/
  • License: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  • Latest release: 0.13.0
    published 9 months ago
  • Versions: 17
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 160 Last month
Rankings
Dependent packages count: 7.4%
Stargazers count: 14.2%
Forks count: 14.3%
Average: 15.9%
Downloads: 21.2%
Dependent repos count: 22.3%
Maintainers (3)
Last synced: 4 months ago

Dependencies

.github/workflows/tests.yaml actions
  • abatilo/actions-poetry v2.1.6 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi
  • ConfigSpace ^0.4.19
  • grakel ^0.1.9
  • matplotlib ^3.4
  • more-itertools ^9.0.0
  • networkx ^2.6.3
  • nltk ^3.6.4
  • numpy --- - !ruby/hash:ActiveSupport::HashWithIndifferentAccess version: "~1.21.0" python: "<3.8" - !ruby/hash:ActiveSupport::HashWithIndifferentAccess version: "^1.22.0" python: ">=3.8"
  • pandas ^1.3.1
  • path ^16.2.0
  • portalocker ^2.6.0
  • python >=3.7.1,<3.11
  • scipy ^1.7
  • seaborn ^0.12.1
  • statsmodels ^0.13.2
  • termcolor ^1.1.0
  • torch >=1.7.0,<1.13.0