Skip to content

Commit 0e3b30e

Browse files
marios1861marios1861
committed
✨ feat(project): init commit
0 parents  commit 0e3b30e

File tree

144 files changed

+8442
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

144 files changed

+8442
-0
lines changed

‎.env.example‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# example of file for storing private and user specific environment variables, like keys or system paths
2+
# rename it to ".env" (excluded from version control by default)
3+
# .env is loaded by train.py automatically
4+
# hydra allows you to reference variables in .yaml configs with special syntax: ${oc.env:MY_VAR}
5+
6+
MY_VAR="/home/user/my/system/path"

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## What does this PR do?
2+
3+
<!--
4+
Please include a summary of the change and which issue is fixed.
5+
Please also include relevant motivation and context.
6+
List any dependencies that are required for this change.
7+
List all the breaking changes introduced by this pull request.
8+
-->
9+
10+
Fixes #\<issue_number>
11+
12+
## Before submitting
13+
14+
- [ ] Did you make sure the **title is self-explanatory** and **the description concisely explains the PR**?
15+
- [ ] Did you make sure your **PR does only one thing**, instead of bundling different changes together?
16+
- [ ] Did you list all the **breaking changes** introduced by this pull request?
17+
- [ ] Did you **test your PR locally** with `pytest` command?
18+
- [ ] Did you **run pre-commit hooks** with `pre-commit run -a` command?
19+
20+
## Did you have fun?
21+
22+
Make sure you had fun coding 🙃

‎.github/codecov.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
coverage:
2+
status:
3+
# measures overall project coverage
4+
project:
5+
default:
6+
threshold: 100% # how much decrease in coverage is needed to not consider success
7+
8+
# measures PR or single commit coverage
9+
patch:
10+
default:
11+
threshold: 100% # how much decrease in coverage is needed to not consider success
12+
13+
14+
# project: off
15+
# patch: off

‎.github/dependabot.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "pip" # See documentation for possible values
9+
directory: "/" # Location of package manifests
10+
schedule:
11+
interval: "daily"
12+
ignore:
13+
- dependency-name: "pytorch-lightning"
14+
update-types: ["version-update:semver-patch"]
15+
- dependency-name: "torchmetrics"
16+
update-types: ["version-update:semver-patch"]

‎.github/release-drafter.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name-template: "v$RESOLVED_VERSION"
2+
tag-template: "v$RESOLVED_VERSION"
3+
4+
categories:
5+
- title: "🚀 Features"
6+
labels:
7+
- "feature"
8+
- "enhancement"
9+
- title: "🐛 Bug Fixes"
10+
labels:
11+
- "fix"
12+
- "bugfix"
13+
- "bug"
14+
- title: "🧹 Maintenance"
15+
labels:
16+
- "maintenance"
17+
- "dependencies"
18+
- "refactoring"
19+
- "cosmetic"
20+
- "chore"
21+
- title: "📝️ Documentation"
22+
labels:
23+
- "documentation"
24+
- "docs"
25+
26+
change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
27+
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions
28+
29+
version-resolver:
30+
major:
31+
labels:
32+
- "major"
33+
minor:
34+
labels:
35+
- "minor"
36+
patch:
37+
labels:
38+
- "patch"
39+
default: patch
40+
41+
template: |
42+
## Changes
43+
44+
$CHANGES

‎.github/workflows/docs.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: website
2+
3+
# build the documentation whenever there are new commits on main
4+
on:
5+
push:
6+
branches:
7+
- main
8+
# Alternative: only build for tags.
9+
# tags:
10+
# - '*'
11+
12+
# security: restrict permissions for CI jobs.
13+
permissions:
14+
contents: read
15+
16+
jobs:
17+
# Build the documentation and upload the static HTML files as an artifact.
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
- uses: actions/setup-python@v5
23+
with:
24+
python-version: "3.10"
25+
26+
# ADJUST THIS: install all dependencies (including pdoc)
27+
- run: pip install -r requirements.txt
28+
- run: pip install pdoc
29+
- run: pip install -e .
30+
# ADJUST THIS: build your documentation into docs/.
31+
# We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
32+
- run: pdoc -o docs/ src/ptame --logo "https://placedog.net/300?random"
33+
34+
- uses: actions/upload-pages-artifact@v3
35+
with:
36+
path: docs/
37+
38+
# Deploy the artifact to GitHub pages.
39+
# This is a separate job so that only actions/deploy-pages has the necessary permissions.
40+
deploy:
41+
needs: build
42+
runs-on: ubuntu-latest
43+
permissions:
44+
pages: write
45+
id-token: write
46+
environment:
47+
name: github-pages
48+
url: ${{ steps.deployment.outputs.page_url }}
49+
steps:
50+
- id: deployment
51+
uses: actions/deploy-pages@v4

‎.github/workflows/release-drafter.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
# branches to consider in the event; optional, defaults to all
6+
branches:
7+
- main
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
update_release_draft:
14+
permissions:
15+
# write permission is required to create a github release
16+
contents: write
17+
# write permission is required for autolabeler
18+
# otherwise, read permission is required at least
19+
pull-requests: write
20+
21+
runs-on: ubuntu-latest
22+
23+
steps:
24+
# Drafts your next Release notes as Pull Requests are merged into "master"
25+
- uses: release-drafter/release-drafter@v6
26+
env:
27+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
# Byte-compiled / optimized / DLL files
2+
**/__pycache__
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# pdoc
72+
docs/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.venv
106+
env/
107+
venv/
108+
ENV/
109+
env.bak/
110+
venv.bak/
111+
node_modules/
112+
113+
# Spyder project settings
114+
.spyderproject
115+
.spyproject
116+
117+
# Rope project settings
118+
.ropeproject
119+
120+
# mkdocs documentation
121+
site
122+
123+
# mypy
124+
.mypy_cache/
125+
.dmypy.json
126+
dmypy.json
127+
128+
# Pyre type checker
129+
.pyre/
130+
131+
### VisualStudioCode
132+
.vscode/*
133+
!.vscode/settings.json
134+
!.vscode/tasks.json
135+
!.vscode/launch.json
136+
!.vscode/extensions.json
137+
*.code-workspace
138+
139+
# JetBrains
140+
.idea/
141+
142+
# Data & Models
143+
*.h5
144+
*.tar
145+
*.tar.gz
146+
_torchshow
147+
148+
# Lightning-Hydra-Template
149+
configs/local/default.yaml
150+
data/*
151+
!data/datalists/
152+
logs/*
153+
.env
154+
155+
# Printed maps - Qualitative explain results
156+
printed_maps/*
157+
masks/*
158+
159+
# Aim logging
160+
.aim
161+
162+
# nohup output
163+
nohup.out
164+
,*
165+
166+
**/google_auth.json

0 commit comments

Comments
 (0)