Skip to content

Commit

Permalink
Merge branch 'v5' into dependabot/github_actions/dependabot-updates/a…
Browse files Browse the repository at this point in the history
…ctions/github-script-7
  • Loading branch information
schobbejak authored Oct 2, 2024
2 parents d48d37a + 5a7463f commit 239a311
Show file tree
Hide file tree
Showing 74 changed files with 1,221 additions and 554 deletions.
9 changes: 6 additions & 3 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
*.yaml @TeamEpochGithub/core-maintainers
*.yml @TeamEpochGithub/core-maintainers
*.toml @TeamEpochGithub/core-maintainers
*.py @TeamEpochGithub/packages
*.md @TeamEpochGithub/packages
*.yaml @TeamEpochGithub/packages
*.yml @TeamEpochGithub/packages
*.toml @TeamEpochGithub/packages
*.txt @TeamEpochGithub/packages
1 change: 1 addition & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ updates:
directory: "/"
schedule:
interval: "monthly"
target-branch: "dependabot-updates"
- package-ecosystem: "pip"
directory: "/"
schedule:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/label-issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
issues: write
steps:
- name: checkout
uses: actions/checkout@v2
uses: actions/checkout@v4
- name: Check if issue has a milestone
id: check_milestone
uses: actions/github-script@v7
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/main-branch-testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ jobs:

steps:
- name: Install Node.js
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: ${{ env.NODE_VERSION }}

- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}

Expand All @@ -48,4 +48,4 @@ jobs:
- name: Test with pytest
run: |
venv/bin/python -m pytest --cov=epochalyst --cov-branch --cov-fail-under=95 tests
venv/bin/python -m pytest --cov=epochlib --cov-branch --cov-fail-under=95 tests
8 changes: 4 additions & 4 deletions .github/workflows/publish-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4.1.6
uses: actions/checkout@v4
- name: Install the latest version of Rye
uses: eifinger/setup-rye@v3.0.2
uses: eifinger/setup-rye@v4.2.1
- name: Build the package
run: rye build
- uses: actions/upload-artifact@v4.3.3
- uses: actions/upload-artifact@v4.3.6
with:
path: ./dist

Expand All @@ -22,7 +22,7 @@ jobs:
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/p/epochalyst
url: https://pypi.org/p/epochlib
permissions:
# IMPORTANT: this permission is mandatory for trusted publishing
id-token: write
Expand Down
35 changes: 35 additions & 0 deletions .github/workflows/retarget-dependabot-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Retarget Dependabot PR

on:
pull_request:
branches:
- dependabot-updates
types:
- opened
- synchronize

jobs:
retarget:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Get all branches
run: |
git fetch --all
git branch -r > branches.txt
cat branches.txt
- name: Find the lowest version branch
id: find_branch
run: |
lowest_branch=$(grep -o 'origin/v[0-9]*\.[0-9]*' branches.txt | sort -V | head -n 1 | sed 's/origin\///')
echo "lowest_branch=$lowest_branch" >> $GITHUB_ENV
- name: Retarget PR to lowest version branch
if: success()
run: |
gh pr edit ${{ github.event.pull_request.number }} --base ${{ env.lowest_branch }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4 changes: 2 additions & 2 deletions .github/workflows/static-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4.1.6
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python 3.10.14
uses: actions/setup-python@v5.1.0
uses: actions/setup-python@v5
with:
python-version: 3.10.14
- name: Run pre-commit
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/version-branch-testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,25 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4.1.6
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install the latest version of Rye
uses: eifinger/setup-rye@v3.0.2
uses: eifinger/setup-rye@v4.2.1
- name: Setup the environment
run: rye sync --all-features
- name: Test with pytest
run: rye run pytest --cov=epochalyst --cov-branch --cov-fail-under=95 tests
run: rye run pytest --cov=epochlib --cov-branch --cov-fail-under=95 tests

build:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4.1.6
uses: actions/checkout@v4
- name: Install the latest version of Rye
uses: eifinger/setup-rye@v3.0.2
uses: eifinger/setup-rye@v4.2.1
- name: Build the package
run: rye build
- uses: actions/upload-artifact@v4.3.3
- uses: actions/upload-artifact@v4.3.6
with:
path: ./dist
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,6 @@ cython_debug/
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
.idea/

# Ignore data files
data/

# Ignore logs
/logging/
/wandb/
Expand Down
14 changes: 7 additions & 7 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Selm"
name-particle: "van"
given-names: "Jasper"
affiliation: "TU Delft Dream Team Epoch"
email: "jmvanselm@gmail.com"
- family-names: "Lim"
given-names: "Jeffrey"
affiliation: "TU Delft Dream Team Epoch"
Expand All @@ -18,11 +23,6 @@ authors:
given-names: "Cahit Tolga"
affiliation: "TU Delft Dream Team Epoch"
email: "cahittolgakopar@gmail.com"
- family-names: "Selm"
name-particle: "van"
given-names: "Jasper"
affiliation: "TU Delft Dream Team Epoch"
email: "jmvanselm@gmail.com"
- family-names: "Ebersberger"
given-names: "Ariel"
affiliation: "TU Delft Dream Team Epoch"
Expand All @@ -39,7 +39,7 @@ authors:
given-names: "Daniel"
affiliation: "TU Delft Dream Team Epoch"
email: "danieldediosallegue@gmail.com"
title: "Epochalyst"
title: "EpochLib"
version: 1.0.0
date-released: 2024-03-19
url: "https://github.com/TeamEpochGithub/epochalyst"
url: "https://github.com/TeamEpochGithub/epochlib"
44 changes: 16 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,55 @@
![image](https://raw.githubusercontent.com/TeamEpochGithub/epochalyst/main/assets/Epochalyst_Logo_Auto.svg)
![image](https://raw.githubusercontent.com/TeamEpochGithub/epochlib/main/assets/EpochLib_Logo_Auto.svg)

[![Team Epoch](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2FJeffrey-Lim%2Fepoch-dvdscreensaver%2Fmaster%2Fbadge.json)](https://teamepoch.ai/)
[![PyPI Latest Release](https://img.shields.io/pypi/v/epochalyst.svg)](https://pypi.org/project/epochalyst/)
[![PyPI Downloads](https://img.shields.io/pypi/dm/epochalyst.svg?label=PyPI%20downloads)](https://pypi.org/project/epochalyst/)
[![PyPI Latest Release](https://img.shields.io/pypi/v/epochlib.svg)](https://pypi.org/project/epochlib/)
[![PyPI Downloads](https://img.shields.io/pypi/dm/epochlib.svg?label=PyPI%20downloads)](https://pypi.org/project/epochlib/)
[![Python Version](https://img.shields.io/badge/Python-3.10_|_3.11_|_3.12-4584b6.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI2NCIgaGVpZ2h0PSI2NCIgdmlld0JveD0iMCAwIDMyIDMyIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9IkEiIHgxPSI4MTEuNTI3IiB5MT0iNTc0Ljg5NSIgeDI9IjY2NS4yNTUiIHkyPSI1NzMuNzMyIiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSI+PHN0b3Agb2Zmc2V0PSIwIiBzdG9wLWNvbG9yPSIjMzY2YTk2Ii8+PHN0b3Agb2Zmc2V0PSIxIiBzdG9wLWNvbG9yPSIjMzY3OWIwIi8+PC9saW5lYXJHcmFkaWVudD48bGluZWFyR3JhZGllbnQgaWQ9IkIiIHgxPSI4NjIuODI0IiB5MT0iNjQyLjE3NiIgeDI9IjU3My4yNzYiIHkyPSI2NDIuMTc2IiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSI+PHN0b3Agb2Zmc2V0PSIwIiBzdG9wLWNvbG9yPSIjZmZjODM2Ii8+PHN0b3Agb2Zmc2V0PSIxIiBzdG9wLWNvbG9yPSIjZmZlODczIi8+PC9saW5lYXJHcmFkaWVudD48L2RlZnM+PGcgdHJhbnNmb3JtPSJtYXRyaXgoLjE2MTcgMCAwIC4xNTgwODkgLTEwNy41Mzc2NCAtODEuNjYxODcpIj48cGF0aCBkPSJNNzE2LjI1NSA1NDQuNDg3YzAtMTMuNjIzIDMuNjUzLTIxLjAzNCAyMy44MjItMjQuNTYzIDEzLjY5My0yLjQgMzEuMjUtMi43IDQ3LjYyNyAwIDEyLjkzNSAyLjEzNSAyMy44MjIgMTEuNzcgMjMuODIyIDI0LjU2M3Y0NC45NDVjMCAxMy4xODItMTAuNTcgMjMuOTgtMjMuODIyIDIzLjk4aC00Ny42MjdjLTE2LjE2NCAwLTI5Ljc4NyAxMy43ODItMjkuNzg3IDI5LjM2M3YyMS41NjRoLTE2LjM3NmMtMTMuODUyIDAtMjEuOTE3LTkuOTg4LTI1LjMwNS0yMy45NjQtNC41Ny0xOC43NzYtNC4zNzYtMjkuOTYzIDAtNDcuOTQ1IDMuNzk0LTE1LjY4NyAxNS45MTctMjMuOTY0IDI5Ljc3LTIzLjk2NGg2NS41MnYtNmgtNDcuNjQ1di0xNy45OHoiIGZpbGw9InVybCgjQSkiLz48cGF0aCBkPSJNODExLjUyNyA2ODguMzJjMCAxMy42MjMtMTEuODIzIDIwLjUyMy0yMy44MjIgMjMuOTY0LTE4LjA1MiA1LjE4OC0zMi41NCA0LjM5NC00Ny42MjcgMC0xMi42LTMuNjctMjMuODIyLTExLjE3LTIzLjgyMi0yMy45NjR2LTQ0Ljk0NWMwLTEyLjkzNSAxMC43ODItMjMuOTggMjMuODIyLTIzLjk4aDQ3LjYyN2MxNS44NjQgMCAyOS43ODctMTMuNzEgMjkuNzg3LTI5Ljk2M3YtMjAuOTY0aDE3Ljg1OGMxMy44NyAwIDIwLjQgMTAuMzA1IDIzLjgyMiAyMy45NjQgNC43NjQgMTguOTcgNC45NzYgMzMuMTU3IDAgNDcuOTQ1LTQuODE3IDE0LjM2NC05Ljk3IDIzLjk2NC0yMy44MjIgMjMuOTY0SDc2My45djZoNDcuNjI3djE3Ljk4eiIgZmlsbD0idXJsKCNCKSIvPjxwYXRoIGQ9Ik03MjguMTY2IDU0MS41MDVjMC00Ljk3NiAzLjk4OC05IDguOTMtOSA0LjkyMyAwIDguOTMgNC4wMjMgOC45MyA5IDAgNC45Ni00LjAwNiA4Ljk4Mi04LjkzIDguOTgyLTQuOTQgMC04LjkzLTQuMDIzLTguOTMtOC45ODJ6bTUzLjU5IDE0OS43OThjMC00Ljk2IDQuMDA2LTguOTgyIDguOTMtOC45ODIgNC45NCAwIDguOTMgNC4wMjMgOC45MyA4Ljk4MiAwIDQuOTc2LTMuOTg4IDktOC45MyA5LTQuOTIzIDAtOC45My00LjAyMy04LjkzLTl6IiBmaWxsPSIjZmZmIi8+PC9nPjwvc3ZnPg==)](https://www.python.org/downloads/)
[![Rye](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/rye/main/artwork/badge.json)](https://rye-up.com)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/TeamEpochGithub/epochalyst/main.svg)](https://results.pre-commit.ci/latest/github/TeamEpochGithub/epochalyst/main)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/TeamEpochGithub/epochlib/main.svg)](https://results.pre-commit.ci/latest/github/TeamEpochGithub/epochlib/main)

Epochalyst is the base for [Team Epoch](https://teamepoch.ai/) competitions.
EpochLib is the base for [Team Epoch](https://teamepoch.ai/) competitions.

This package contains many modules and classes necessary to construct the src code for machine learning competitions.

Epochalyst: A fusion of "Epoch" and "Catalyst," this name positions your pipeline as a catalyst in the field of machine learning, sparking significant advancements and transformations.
This library package contains many modules and classes necessary to construct the src code for machine learning competitions.

## Installation

Install `epochalyst` using [Rye](https://rye.astral.sh/):
Install `epochlib` using [Rye](https://rye.astral.sh/):

```shell
rye add epochalyst
rye add epochlib
```

Or via pip:

```shell
pip install epochalyst
pip install epochlib
```

### Optional Dependencies

Depending on what data libraries you use, you can install the following optional dependencies:
```shell
rye add epochalyst[numpy,pandas,dask,polars] # Pick one or more of these
rye add epochlib[numpy,pandas,dask,polars] # Pick one or more of these
```

Depending on what type of competition you are participating in, you can install the following optional dependencies:
```shell
rye add epochalyst[image,audio] # Pick one or more of these
rye add epochlib[image,audio] # Pick one or more of these
```

Aside from that, you can install the following optional dependencies:
```shell
rye add epochalyst[onnx,openvino] # Optimizing model inference
rye add epochlib[onnx,openvino] # Optimizing model inference
```

## Pytest coverage report

To generate pytest coverage report run

```shell
rye run pytest --cov=epochalyst --cov-branch --cov-report=html:coverage_re
rye run pytest --cov=epochlib --cov-branch --cov-report=html:coverage_re
```

## pre-commit
Expand All @@ -72,21 +70,11 @@ rye run pre-commit run --all-files

## Documentation

Documentation is generated using [Sphinx](https://www.sphinx-doc.org/en/master/) and can be found [here](https://teamepochgithub.github.io/epochalyst).
Documentation is generated using [Sphinx](https://www.sphinx-doc.org/en/master/) and can be found [here](https://teamepochgithub.github.io/epochlib).

To make the documentation yourself, run `make html` with `docs` as the working directory.
The documentation can then be found in `docs/_build/html/index.html`.

## Contributors

Epochalyst was created by [Team Epoch IV](https://teamepoch.ai/team#iv), based in the [Dream Hall](https://www.tudelft.nl/ddream) of the [Delft University of Technology](https://www.tudelft.nl/).
## Maintainers

[![Github Badge](https://img.shields.io/badge/-Emiel_Witting-24292e?style=flat&logo=Github)](https://github.com/EWitting)
[![Github Badge](https://img.shields.io/badge/-Jeffrey_Lim-24292e?style=flat&logo=Github)](https://github.com/Jeffrey-Lim)
[![Github Badge](https://img.shields.io/badge/-Hugo_de_Heer-24292e?style=flat&logo=Github)](https://github.com/hjdeheer)
[![Github Badge](https://img.shields.io/badge/-Jasper_van_Selm-24292e?style=flat&logo=Github)](https://github.com/schobbejak)
[![Github Badge](https://img.shields.io/badge/-Tolga_Kopar-24292e?style=flat&logo=Github)](https://github.com/tolgakopar)
[![Github Badge](https://img.shields.io/badge/-Ariel_Ebersberger-24292e?style=flat&logo=Github)](https://github.com/justanotherariel)
[![Github Badge](https://img.shields.io/badge/-Gregoire_Dumont-24292e?style=flat&logo=Github)](https://github.com/Gregoire-Andre-Dumont)
[![Github Badge](https://img.shields.io/badge/-Kristóf_Sándor-24292e?style=flat&logo=Github)](https://github.com/emherk)
[![Github Badge](https://img.shields.io/badge/-Daniel_De_Dios_Allegue-24292e?style=flat&logo=Github)](https://github.com/daniallegue)
EpochLib is maintained by [Team Epoch](https://teamepoch.ai), based in the [Dream Hall](https://www.tudelft.nl/ddream) of the [Delft University of Technology](https://www.tudelft.nl/).
4 changes: 2 additions & 2 deletions assets/Epochalyst_Icon.svg → assets/EpochLib_Icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 239a311

Please sign in to comment.