Skip to content

Commit

Permalink
initial package
Browse files Browse the repository at this point in the history
  • Loading branch information
ravescovi committed Jun 10, 2024
0 parents commit ebb67d0
Show file tree
Hide file tree
Showing 20 changed files with 993 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'bug'
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Code with explanation
2. How to run code
3. The error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment (please complete the following information):**
- OS: [e.g. Linux]
- Package versions implicated in the error (torch, mdlearn versions, etc)

**Additional context**
Add any other context about the problem here.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: 'enhancement'
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Other issue template
about: Any issue that does not fit the other templates
title: ''
labels: ''
assignees: ''

---

**Description**
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/question-issue-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Question issue template
about: Ask a question about how to use mdlearn
title: ''
labels: question
assignees: ''

---

**Describe the question**
15 changes: 15 additions & 0 deletions .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Pre-Commit Checks

on:
push:

jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
name: Checkout code
- uses: actions/setup-python@v3
name: Setup Python
- uses: pre-commit/[email protected]
name: Run Pre-Commit Checks
22 changes: 22 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Pytest Unit Tests

on: [push]

jobs:
build_and_test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
name: Checkout code
- name: Set up Python 3.9
uses: actions/setup-python@v4
with:
python-version: 3.9
- name: Setup PDM
uses: pdm-project/setup-pdm@v3
with:
python-version: 3.9
- name: Build the Project
run: make init build
- name: Test with pytest
run: make test
Loading

0 comments on commit ebb67d0

Please sign in to comment.