Aufgrund einer Konfigurationsänderung wird die GitLab Registry ab 10 Uhr nur Read Only zur Verfügung stehen. / Due to a configuration change, the GitLab Registry will be available for read-only access from 10am.

Commit 164bf17b authored by Marcel Rieger's avatar Marcel Rieger

Add initial files.

parent 9b1eaf62
[flake8]
max-line-length = 101
ignore = E306, E402, E128, E722, E731, E741, F812, F822, F403, F401, W504, W605
Copyright (c) 2018-2019, Marcel Rieger
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# Lorentz Boost Network (LBN) [![pipeline status](https://git.rwth-aachen.de/3pia/lbn/badges/master/pipeline.svg)](https://git.rwth-aachen.de/3pia/lbn/commits/master)
TensorFlow implementation of the Lorentz Boost Network from [arXiv:XXXX.XXXXX [hep-ex]](https://arxiv.org/abs/XXXX.XXXXX).
Original repository: [git.rwth-aachen.de/3pia/lbn](https://git.rwth-aachen.de/3pia/lbn)
### Usage example
```python
from lbn import LBN
# initialize the LBN, set 10 combinations and pairwise boosting
lbn = LBN(10, boost_mode=LBN.PAIRS)
# create a feature tensor based on input four-vectors
features = lbn(four_vectors)
# use the features as input for a subsequent, application-specific network
...
```
### Installation and dependencies
Via [pip](https://pypi.python.org/pypi/lbn):
```bash
pip install lbn
```
NumPy and TensorFlow are the only dependencies.
### Testing
Tests should be run for Python 2 and 3. The following commands assume you are root directory of the LBN respository:
```bash
python -m unittest test
# or via docker, python 2
docker run --rm -v `pwd`:/root/lbn -w /root/lbn tensorflow/tensorflow:latest python -m unittest test
# or via docker, python 3
docker run --rm -v `pwd`:/root/lbn -w /root/lbn tensorflow/tensorflow:latest-py3 python -m unittest test
```
### Contributing
If you like to contribute, we are happy to receive pull requests. Just make sure to add new test cases and run the tests. Also, please use a coding style that is compatible with our `.flake8` config.
### Development
- Original source hosted at [RWTH GitLab](https://git.rwth-aachen.de/3pia/lbn)
- Report issues, questions, feature requests on [RWTH GitLab Issues](https://git.rwth-aachen.de/3pia/lbn/issues)
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment