diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index bce087b..8d2ac49 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -32,7 +32,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install -e ".[all]" + pip install -e ".[dev,solver]" - name: Run pytest run: pytest tests/*.py \ No newline at end of file diff --git a/README.md b/README.md index f56c5d5..d932971 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # RouteFinder [![arXiv](https://img.shields.io/badge/arXiv-2406.15007-b31b1b.svg)](https://arxiv.org/abs/2406.15007) [![OpenReview](https://img.shields.io/badge/⚖️-OpenReview-8b1b16)](https://openreview.net/forum?id=hCiaiZ6e4G) [![Slack](https://img.shields.io/badge/slack-chat-611f69.svg?logo=slack)](https://join.slack.com/t/rl4co/shared_invite/zt-1ytz2c1v4-0IkQ8NQH4TRXIX8PrRmDhQ) -[![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](https://opensource.org/licenses/MIT) +[![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](https://opensource.org/licenses/MIT)[![Test](https://github.com/ai4co/routefinder/actions/workflows/tests.yml/badge.svg)](https://github.com/ai4co/routefinder/actions/workflows/tests.yml) _Towards Foundation Models for Vehicle Routing Problems_ @@ -33,7 +33,7 @@ Install the package in editable mode: pip install -e . ``` -if you would like to install baseline solvers as well, please install using `pip install -e '.[solvers]'` +If you would like to install all dependencies including optional solvers, please install using `pip install -e '.[dev,solver]'`. ## 🏁 Quickstart @@ -128,7 +128,7 @@ with additional parameters that can be found in the [eal.py](eal.py) file. ### 🤩 Citation -If you find `RouteFinder` valuable for your research or applied projects: +If you find RouteFinder valuable for your research or applied projects: ``` @inproceedings{berto2024routefinder, diff --git a/pyproject.toml b/pyproject.toml index 18345f3..1fd1eab 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ [build-system] -requires = ["poetry-core>=1.0.0"] +requires = ["poetry"] build-backend = "poetry.core.masonry.api" [tool.poetry] @@ -22,22 +22,17 @@ license = "MIT" [tool.poetry.dependencies] python = ">=3.9,<3.12" rl4co = { git = "https://github.com/ai4co/rl4co.git", branch = "main" } +pytest = { version = "^6.2.5", optional = true } +pytest-cov = { version = "^3.0.0", optional = true } +black = { version = "^23.3.0", optional = true } +ruff = { version = "^0.1.6", optional = true } +pre-commit = { version = "^3.3.3", optional = true } pyvrp = { version = "^0.9.1", optional = true } ortools = { version = "^9.10.4067", optional = true } -# lkh = { git = "git@github.com:leonlan/pylkh.git", rev = "7ba9965", optional = true} - -[tool.poetry.dev-dependencies] -pytest = "^6.2.5" -pytest-cov = "^3.0.0" -black = "^23.3.0" -ruff = "^0.1.6" -pre-commit = "^3.3.3" [tool.poetry.extras] -graph = ["torch_geometric"] -testing = ["pytest", "pytest-cov"] -solvers = ["pyvrp", "ortools"] -all = ["graph", "testing", "solvers", "dev"] +dev = ["pytest", "pytest-cov", "black", "ruff", "pre-commit"] +solver = ["pyvrp", "ortools"] [tool.ruff] select = ["F", "E", "W", "I001"]