Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PyKEEN to ecosystem-ci #50

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from
Draft
1 change: 1 addition & 0 deletions .azure/ci-testig-parameterized.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ jobs:
- "PyTorchLightning/flash_pl-develop.yaml"
- "PyTorchLightning/flash_pl-release.yaml"
- "microsoft/deepspeed-release.yaml"
- "pykeen/pykeen.yaml"
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Here are pre-requisites for your project before adding to the Lightning EcoSyste
```
1. Copy the [template file](actions/_config.yaml) in `configs` folder and call it `<my_project_name>.yaml`.
```
cp configs/template.yaml configs/<my_project_name>.yaml
cp actions/_config.yaml configs/<my_project_name>.yaml
```
1. At the minimum, modify the `HTTPS` variable to point to your repository. See [Configuring my project](https://github.com/PyTorchLightning/ecosystem-ci/tree/main#configuring-my-project) for more options.
```yaml
Expand Down
59 changes: 59 additions & 0 deletions configs/pykeen/pykeen.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
target_repository:
HTTPS: https://github.com/pykeen/pykeen.git
# OPTIONAL, for some protected repository
# username: my-nick
# OPTIONAL, paired with the username
# password: dont-tell-anyone
# OPTIONAL, overrides the user/pass
# token: authentication-token
mberr marked this conversation as resolved.
Show resolved Hide resolved
# OPTIONAL, checkout a particular branch or a tag
# TODO: change once https://github.com/pykeen/pykeen/pull/930 is merged
checkout: pyl-tests
# checkout: master
# OPTIONAL, define installing package extras
install_extras: lightning
# OPTIONAL, install additional requirements from a file
# requirements_file: requirements.txt
# copy some test from the target repository
copy_tests:
- tests/test_lightning.py

contact:
slack:
- U03DAAVMLSH
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is my Slack account at https://pytorch-lightning.slack.com

mberr marked this conversation as resolved.
Show resolved Hide resolved
email: []

# OPTIONAL, running before installing your project
# WARNING: this is custom for given OS, we do not manage any inter OS compatibility
#before_install:
# - pip install Cython==3.56

# OPTIONAL, if any installation require some env. variables
#env:
# HOROVOD_BUILD_ARCH_FLAGS: "-mfma"
# # HOROVOD_WITHOUT_MXNET: 1
# # HOROVOD_WITHOUT_TENSORFLOW: 1

mberr marked this conversation as resolved.
Show resolved Hide resolved
dependencies:
- name: pytorch-lightning
HTTPS: https://github.com/PyTorchLightning/pytorch-lightning.git
checkout: release/latest
# install_extras: all
# - name: Cython
# checkout: 0.29.24

# OPTIONAL, running before installing your project
# WARNING: this is custom for given OS, we do not manage any inter OS compatibility
#before_test:
# - wget https://pl-flash-data.s3.amazonaws.com/titanic.zip

testing:
dirs:
- tests/
# # OPTIONAL, additional pytest arguments
# pytest_args: --strict

runtimes:
- {os: "ubuntu-20.04", python-version: "3.10"}
- {os: "macOS-10.15", python-version: "3.9"}
mberr marked this conversation as resolved.
Show resolved Hide resolved
- {os: "windows-2019", python-version: "3.8"}
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In PyKEEN we are testing with Python 3.8 and 3.10, which are the minimum and maximum Python version we officially support. We test for both, Ubuntu and Windows, but do not have specific tests for macOS.

If you have any suggestions here, feel free to share them. The main reason we are interested in integrating with PyTorchLightning/ecosystem-ci is the possibility to run tests with GPUs, which we at PyKEEN do not have available for continous testing.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that is fine we can test only Linux and Win or just Ubuntu 馃Ζ