epochlib
This package contains the code for Team Epoch's pipeline
Science Score: 44.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
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (4.0%) to scientific vocabulary
Keywords
Repository
This package contains the code for Team Epoch's pipeline
Basic Info
- Host: GitHub
- Owner: TeamEpochGithub
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://teamepoch.ai
- Size: 7.39 MB
Statistics
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 25
- Releases: 23
Topics
Metadata Files
README.md
EpochLib is the base for Team Epoch competitions.
This library package contains many modules and classes necessary to construct the src code for machine learning competitions.
Installation
Install epochlib using Rye:
shell
rye add epochlib
Or via pip:
shell
pip install epochlib
Optional Dependencies
Depending on what data libraries you use, you can install the following optional dependencies:
shell
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 epochlib[image,audio] # Pick one or more of these
Aside from that, you can install the following optional dependencies:
shell
rye add epochlib[onnx,openvino] # Optimizing model inference
Pytest coverage report
To generate pytest coverage report run
shell
rye run pytest --cov=epochlib --cov-branch --cov-report=html:coverage_re
pre-commit
This repository uses pre-commit with Ruff and MyPy hooks for code quality checks and auto-formatting. To install the pre-commit hooks, run:
bash
rye run pre-commit install
To run the pre-commit checks on all files, run:
bash
rye run pre-commit run --all-files
Documentation
Documentation is generated using Sphinx and can be found here.
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.
Architectural guidelines
- Generally 'one class = one file' unless they are very tightly coupled.
- Use init.py to change import paths so they are shorter for the end user
Maintainers
EpochLib is maintained by Team Epoch, based in the Dream Hall of the Delft University of Technology.
Owner
- Name: Team Epoch
- Login: TeamEpochGithub
- Kind: organization
- Email: info@teamepoch.net
- Website: https://www.teamepoch.net/
- Repositories: 1
- Profile: https://github.com/TeamEpochGithub
Citation (CITATION.cff)
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" email: "Jeffrey-Lim@outlook.com" - family-names: "Witting" given-names: "Emiel" affiliation: "TU Delft Dream Team Epoch" email: "emiel.witting@gmail.com" - family-names: "Heer" name-particle: "de" given-names: "Hugo" affiliation: "TU Delft Dream Team Epoch" email: "hugodeheer1234@gmail.com" - family-names: "Kopar" given-names: "Cahit Tolga" affiliation: "TU Delft Dream Team Epoch" email: "cahittolgakopar@gmail.com" - family-names: "Ebersberger" given-names: "Ariel" affiliation: "TU Delft Dream Team Epoch" email: "ariel@ebersberger.io" - family-names: "Dumont" given-names: "Gregoire" affiliation: "TU Delft Dream Team Epoch" email: "dumont.gregoire.a@gmail.com" - family-names: "Sándor" given-names: "Kristóf" affiliation: "TU Delft Dream Team Epoch" email: "emherk512@gmail.com" - family-names: "De Dios Allegue" given-names: "Daniel" affiliation: "TU Delft Dream Team Epoch" email: "danieldediosallegue@gmail.com" title: "EpochLib" version: 1.0.0 date-released: 2024-03-19 url: "https://github.com/TeamEpochGithub/epochlib"
GitHub Events
Total
- Create event: 32
- Release event: 3
- Issues event: 11
- Watch event: 2
- Delete event: 31
- Issue comment event: 20
- Push event: 52
- Gollum event: 2
- Pull request review event: 10
- Pull request event: 65
Last Year
- Create event: 32
- Release event: 3
- Issues event: 11
- Watch event: 2
- Delete event: 31
- Issue comment event: 20
- Push event: 52
- Gollum event: 2
- Pull request review event: 10
- Pull request event: 65
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 7
- Total pull requests: 27
- Average time to close issues: 5 months
- Average time to close pull requests: 19 days
- Total issue authors: 2
- Total pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.52
- Merged pull requests: 11
- Bot issues: 0
- Bot pull requests: 18
Past Year
- Issues: 5
- Pull requests: 27
- Average time to close issues: 17 days
- Average time to close pull requests: 19 days
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.52
- Merged pull requests: 11
- Bot issues: 0
- Bot pull requests: 18
Top Authors
Issue Authors
- schobbejak (12)
- Jeffrey-Lim (1)
Pull Request Authors
- dependabot[bot] (28)
- schobbejak (11)
- Jeffrey-Lim (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 19 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 4
- Total maintainers: 1
pypi.org: epochlib
Epoch Libraries is the base for Team Epoch competitions.
- Homepage: https://teamepoch.ai/
- Documentation: https://TeamEpochGithub.github.io/epochlib/
- License: MIT License Copyright (c) 2024 Team Epoch Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
Latest release: 5.1.0
published 12 months ago