Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit ea6ed7a

Browse files
serviceosaurus[bot]github-actions[bot]
authored andcommittedFeb 6, 2025
✅ Ready to clone and code.
1 parent 652b646 commit ea6ed7a

File tree

15 files changed

+30
-31
lines changed

15 files changed

+30
-31
lines changed
 

‎.github/rename_project.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ echo "Description: $description";
1717
echo "Renaming project..."
1818

1919
original_author="UKPLab"
20-
original_name="ukp_project_template"
21-
original_urlname="ukp-project-template"
22-
original_description="The official template for new Python projects at UKP Lab"
20+
original_name="iclr2025_mbr_uncertainty"
21+
original_urlname="iclr2025-mbr-uncertainty"
22+
original_description="Awesome iclr2025_mbr_uncertainty created by UKPLab"
2323
# Iterate over all files in the repository
2424
git ls-files | while read -r filename; do
2525
# Exclude .github/workflows/rename_project.yml from renaming

‎.github/template.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,4 +136,4 @@ dmypy.json
136136

137137
# Project files
138138
sketch*
139-
ukp_project_template/sketch*
139+
iclr2025_mbr_uncertainty/sketch*

‎ABOUT_THIS_TEMPLATE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ It includes:
99
- 📃 Documentation structure using [mkdocs](http://www.mkdocs.org)
1010
- 🧪 Testing structure using [pytest](https://docs.pytest.org/en/latest/)
1111
- ✅ Code linting using [pylint](https://pypi.org/project/pylint/)
12-
- 🎯 Entry points to execute your program using `python -m <ukp_project_template>` with basic CLI argument parsing.
13-
- 🔄 Continuous integration using [Github Actions](https://github.com/UKPLab/ukp-project-template/actions) with jobs to check, lint and test your project.
12+
- 🎯 Entry points to execute your program using `python -m <iclr2025_mbr_uncertainty>` with basic CLI argument parsing.
13+
- 🔄 Continuous integration using [Github Actions](https://github.com/UKPLab/iclr2025-mbr-uncertainty/actions) with jobs to check, lint and test your project.
1414

1515
Are there any changes you'd like to request? Feel free to fork and open a pull request!
1616

@@ -46,7 +46,7 @@ Lets take a look at the structure of this template:
4646
├───docs # Auto-generated documentation
4747
│ index.md # Landing page of docs
4848
49-
├───ukp_project_template # The main python package for the project
49+
├───iclr2025_mbr_uncertainty # The main python package for the project
5050
│ base.py # The base module for the project
5151
│ cli.py # Defines CLI instructions
5252
│ __init__.py # This tells Python that this is a package
@@ -63,7 +63,7 @@ Lets take a look at the structure of this template:
6363

6464
### Where should I add new stuff ?
6565

66-
You should create new files and subpackages inside ukp_project_template and implement your functionalities there. Remember to add what you write to `__init__.py` so that the imports work smoothly. Take a look at `base.py` and `__init__.py` to understand how it works.
66+
You should create new files and subpackages inside iclr2025_mbr_uncertainty and implement your functionalities there. Remember to add what you write to `__init__.py` so that the imports work smoothly. Take a look at `base.py` and `__init__.py` to understand how it works.
6767

6868
### Why is `requirements.txt` empty ?
6969

@@ -79,7 +79,7 @@ This file lists all the requirements for testing and development. Use it to sepa
7979

8080
### What is the `.github` folder?
8181

82-
It contains [GitHub Actions](https://docs.github.com/en/actions) that are executed automatically when pushing your code. You can see results for your repository [here](https://github.com/UKPLab/ukp-project-template/actions).
82+
It contains [GitHub Actions](https://docs.github.com/en/actions) that are executed automatically when pushing your code. You can see results for your repository [here](https://github.com/UKPLab/iclr2025-mbr-uncertainty/actions).
8383

8484
### What does the linter workflow do?
8585

‎README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
<img src='logo.png' width='200'>
33
</p>
44

5-
# ukp_project_template
5+
# iclr2025_mbr_uncertainty
66
[![Arxiv](https://img.shields.io/badge/Arxiv-YYMM.NNNNN-red?style=flat-square&logo=arxiv&logoColor=white)](https://put-here-your-paper.com)
7-
[![License](https://img.shields.io/github/license/UKPLab/ukp-project-template)](https://opensource.org/licenses/Apache-2.0)
7+
[![License](https://img.shields.io/github/license/UKPLab/iclr2025-mbr-uncertainty)](https://opensource.org/licenses/Apache-2.0)
88
[![Python Versions](https://img.shields.io/badge/Python-3.9-blue.svg?style=flat&logo=python&logoColor=white)](https://www.python.org/)
9-
[![CI](https://github.com/UKPLab/ukp-project-template/actions/workflows/main.yml/badge.svg)](https://github.com/UKPLab/ukp-project-template/actions/workflows/main.yml)
9+
[![CI](https://github.com/UKPLab/iclr2025-mbr-uncertainty/actions/workflows/main.yml/badge.svg)](https://github.com/UKPLab/iclr2025-mbr-uncertainty/actions/workflows/main.yml)
1010

1111
This is the official template for new Python projects at UKP Lab. It was adapted for the needs of UKP Lab from the excellent [python-project-template](https://github.com/rochacbruno/python-project-template/) by [rochacbruno](https://github.com/rochacbruno).
1212

@@ -48,7 +48,7 @@ pip install -r requirements-dev.txt # Only needed for development
4848

4949
### Using the classes
5050

51-
To import classes/methods of `ukp_project_template` from inside the package itself you can use relative imports:
51+
To import classes/methods of `iclr2025_mbr_uncertainty` from inside the package itself you can use relative imports:
5252

5353
```py
5454
from .base import BaseClass # Notice how I omit the package name
@@ -59,19 +59,19 @@ BaseClass().something()
5959
To import classes/methods from outside the package (e.g. when you want to use the package in some other project) you can instead refer to the package name:
6060

6161
```py
62-
from ukp_project_template import BaseClass # Notice how I omit the file name
63-
from ukp_project_template.subpackage import SubPackageClass # Here it's necessary because it's a subpackage
62+
from iclr2025_mbr_uncertainty import BaseClass # Notice how I omit the file name
63+
from iclr2025_mbr_uncertainty.subpackage import SubPackageClass # Here it's necessary because it's a subpackage
6464

6565
BaseClass().something()
6666
SubPackageClass().something()
6767
```
6868

6969
### Using scripts
7070

71-
This is how you can use `ukp_project_template` from command line:
71+
This is how you can use `iclr2025_mbr_uncertainty` from command line:
7272

7373
```bash
74-
$ python -m ukp_project_template
74+
$ python -m iclr2025_mbr_uncertainty
7575
```
7676

7777
### Expected results

‎docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ For full documentation visit [mkdocs.org](https://www.mkdocs.org).
1818

1919
## Docs
2020

21-
::: ukp_project_template
21+
::: iclr2025_mbr_uncertainty

‎ukp_project_template/__main__.py renamed to ‎iclr2025_mbr_uncertainty/__main__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Entry point for ukp_project_template."""
1+
"""Entry point for iclr2025_mbr_uncertainty."""
22

33
from .cli import main # pragma: no cover
44

File renamed without changes.

‎ukp_project_template/cli.py renamed to ‎iclr2025_mbr_uncertainty/cli.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""CLI interface for ukp_project_template project.
1+
"""CLI interface for iclr2025_mbr_uncertainty project.
22
33
Be creative! do whatever you want!
44
@@ -13,7 +13,7 @@
1313
def main(): # pragma: no cover
1414
"""
1515
The main function executes on commands:
16-
`python -m ukp_project_template` and `$ ukp_project_template `.
16+
`python -m iclr2025_mbr_uncertainty` and `$ iclr2025_mbr_uncertainty `.
1717
1818
This is your program's entry point.
1919

‎mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: ukp_project_template
1+
site_name: iclr2025_mbr_uncertainty
22
nav:
33
- Home: index.md
44

@@ -8,7 +8,7 @@ theme:
88
plugins:
99
- search
1010
- mkdocstrings:
11-
project_name: ukp_project_template
11+
project_name: iclr2025_mbr_uncertainty
1212
handlers:
1313
python:
1414
options:

‎setup.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
"""Python setup.py for ukp_project_template package"""
1+
"""Python setup.py for iclr2025_mbr_uncertainty package"""
22
import io
33
import os
44
from setuptools import find_packages, setup
55

66

77
def read(*paths, **kwargs):
88
"""Read the contents of a text file safely.
9-
>>> read("ukp_project_template", "VERSION")
9+
>>> read("iclr2025_mbr_uncertainty", "VERSION")
1010
'0.1.0'
1111
>>> read("README.md")
1212
...
@@ -30,15 +30,15 @@ def read_requirements(path):
3030

3131

3232
setup(
33-
name="ukp_project_template",
34-
url="https://github.com/UKPLab/ukp-project-template/",
33+
name="iclr2025_mbr_uncertainty",
34+
url="https://github.com/UKPLab/iclr2025-mbr-uncertainty/",
3535
long_description=read("README.md"),
3636
long_description_content_type="text/markdown",
3737
author="author_name",
3838
packages=find_packages(exclude=["tests", ".github"]),
3939
install_requires=read_requirements("requirements.txt"),
4040
entry_points={
41-
"console_scripts": ["ukp_project_template = ukp_project_template.__main__:main"]
41+
"console_scripts": ["iclr2025_mbr_uncertainty = iclr2025_mbr_uncertainty.__main__:main"]
4242
},
4343
extras_require={"test": read_requirements("requirements-dev.txt")},
4444
)

‎tests/test_base.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Tests are defined here
2-
from ukp_project_template import BaseClass
3-
from ukp_project_template.subpackage import SubPackageClass
2+
from iclr2025_mbr_uncertainty import BaseClass
3+
from iclr2025_mbr_uncertainty.subpackage import SubPackageClass
44

55
def test_template():
66
assert True

0 commit comments

Comments
 (0)
Please sign in to comment.