Skip to content

Commit fb85afe

Browse files
heatingmaheatingma
committed
update readme.md
1 parent 0257988 commit fb85afe

1 file changed

Lines changed: 37 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,12 +140,14 @@ After the environment is installed, run the following command to confirm that th
140140

141141
⚠️ **2025-10-21:** We find that on macOS, the ``gurobipy`` package does not support ``Python 3.8`` or earlier. Therefore, please upgrade your Python to at least 3.9.
142142

143+
⚠️ **2026-03-13:** For Python versions 3.9 to 3.11 on macOS, it is necessary to downgrade setuptools (recommended versions: 75.0.0 ~ 80.9.0).
144+
143145

144146
## 📝 **ML4CO-Kit Development status**
145147

146148
We will present the development progress of ML4CO-Kit in the above 5 levels.
147149

148-
**Graph: MCl & MCut & MIS & MVC; Portfolio: MaxRetPO & MinVarPO & MOPO**
150+
**Graph: MCl & MCut & MIS & MVC; Portfolio: MaxRetPO & MinVarPO & MOPO; SAT: SATA & SATP**
149151

150152
**✔: Supported; 📆: Planned for future versions (contributions welcomed!).**
151153

@@ -166,6 +168,13 @@ We will present the development progress of ML4CO-Kit in the above 5 levels.
166168
| Maximum Cut (MCut) | ✔ | ✔ | ✔ | ✔ | ``gpickle``, ``adj_matrix``, ``networkx``, ``csr`` |
167169
| Maximum Independent Set (MIS) | ✔ | ✔ | ✔ | ✔ | ``gpickle``, ``adj_matrix``, ``networkx``, ``csr`` |
168170
| Minimum Vertex Cover (MVC) | ✔ | ✔ | ✔ | ✔ | ``gpickle``, ``adj_matrix``, ``networkx``, ``csr`` |
171+
| **QAP Tasks** |
172+
| Graph Matching (GM) | ✔ | ✔ | ✔ | 📆 | |
173+
| Graph Edit Distance (GED) | ✔ | ✔ | ✔ | 📆 | |
174+
| Koopmans-Beckmann QAP (KQAP) | ✔ | ✔ | ✔ | 📆 | |
175+
| **SAT Tasks** |
176+
| Satisfiability Prediction (SATP) | ✔ | ✔ | ✔ | 📆 | ``cnf`` |
177+
| Satisfying Assignment Prediction (SATA) | ✔ | ✔ | ✔ | 📆 | ``cnf`` |
169178
| **Portfolio Tasks** |
170179
| Maximum Return Portfolio Optimization (MaxRetPO) | ✔ | ✔ | ✔ | 📆 | |
171180
| Minimum Variance Portfolio Optimization (MinVarPO) | ✔ | ✔ | ✔ | 📆 | |
@@ -206,6 +215,17 @@ We will present the development progress of ML4CO-Kit in the above 5 levels.
206215
| | Lognormal (weighted) | Weights with Lognormal distribution | ✔ |
207216
| | Powerlaw (weighted) | Weights with Powerlaw distribution | ✔ |
208217
| | Binomial (weighted) | Weights with Binomial distribution | ✔ |
218+
| **QAP Tasks** |
219+
| GM | ISO | Isomorphic Graph matching | ✔ |
220+
| GM | SUB | Subgraph Graph matching | ✔ |
221+
| **SAT Tasks** |
222+
| (SAT) | PHASE | Near satisfiability phase transition | ✔ |
223+
| | SR | SAT/UNSAT paired generation | ✔ |
224+
| | CA | Community Attachment generator | ✔ |
225+
| | PS | Popularity Similarity generator | ✔ |
226+
| | K_CLIQUE | Reduction-based SAT instance generation | ✔ |
227+
| | K_CLIQUE | Reduction-based SAT instance generation | ✔ |
228+
| | K_CLIQUE | Reduction-based SAT instance generation | ✔ |
209229
| **Portfolio Tasks** |
210230
| (Portfolio) | GBM | Geometric Brownian Motion model | ✔ |
211231
| | Factor | Factor model with k factors and idiosyncratic noise | ✔ |
@@ -258,6 +278,10 @@ We will present the development progress of ML4CO-Kit in the above 5 levels.
258278
| | MCut | Python | [ISCO](https://proceedings.mlr.press/v202/sun23c/sun23c.pdf) | [DISCS](https://github.com/google-research/discs) | ✔ |
259279
| | MIS | Python | [ISCO](https://proceedings.mlr.press/v202/sun23c/sun23c.pdf) | [DISCS](https://github.com/google-research/discs) | ✔ |
260280
| | MVC | Python | [ISCO](https://proceedings.mlr.press/v202/sun23c/sun23c.pdf) | [DISCS](https://github.com/google-research/discs) | ✔ |
281+
| FEMSolver | MCl | Python | [FEM](https://github.com/Fanerst/FEM) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
282+
| | MCut | Python | [FEM](https://github.com/Fanerst/FEM) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
283+
| | MIS | Python | [FEM](https://github.com/Fanerst/FEM) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
284+
| | MVC | Python | [FEM](https://github.com/Fanerst/FEM) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
261285
| KaMISSolver | MIS | Python | [KaMIS](https://github.com/KarlsruheMIS/KaMIS) | [MIS-Bench](https://github.com/MaxiBoether/mis-benchmark-framework) | ✔ |
262286
| LcDegreeSolver | MCl | Python | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
263287
| | MCut | Python | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
@@ -274,6 +298,11 @@ We will present the development progress of ML4CO-Kit in the above 5 levels.
274298
| | MCl | C/C++ | [OR-Tools](https://developers.google.cn/optimization/introduction) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
275299
| | MIS | C/C++ | [OR-Tools](https://developers.google.cn/optimization/introduction) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
276300
| | MVC | C/C++ | [OR-Tools](https://developers.google.cn/optimization/introduction) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
301+
| PyGMSolver | GM | Python | [pygmtools](https://github.com/Thinklab-SJTU/pygmtools) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
302+
| | GED | Python | [pygmtools](https://github.com/Thinklab-SJTU/pygmtools) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
303+
| | KQAP | Python | [pygmtools](https://github.com/Thinklab-SJTU/pygmtools) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
304+
| PySATSolver | SATP | Python | [PySAT](https://github.com/pysathq/pysat) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
305+
| | SATA | Python | [PySAT](https://github.com/pysathq/pysat) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
277306
| RLSASolver | MCl | Python | [RLSA](https://arxiv.org/abs/2502.00277) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
278307
| | MCut | Python | [RLSA](https://arxiv.org/abs/2502.00277) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
279308
| | MIS | Python | [RLSA](https://arxiv.org/abs/2502.00277) | [ML4CO-Kit](https://github.com/Thinklab-SJTU/ML4CO-Kit) | ✔ |
@@ -324,6 +353,13 @@ We will present the development progress of ML4CO-Kit in the above 5 levels.
324353
| **Graph Tasks** |
325354
| (Graph)Wrapper | "[edge_index] label [sol]" | ``gpickle`` |
326355
| (Graph)Wrapper [weighted] | "[edge_index] weights [weights] label [sol]" | ``gpickle`` |
356+
| **QAP Tasks** |
357+
| GMWrapper | -- | ``pickle`` |
358+
| GEDWrapper | -- | ``pickle`` |
359+
| KQAPWrapper | -- | ``pickle`` |
360+
| **SAT Tasks** |
361+
| SATPWrapper | "[vars_num] vars_num [clauses] output [sol]" | ``cnf`` |
362+
| SATAWrapper | "[vars_num] vars_num [clauses] output [sol]" | ``cnf`` |
327363
| **Portfolio Tasks** |
328364
| MaxRetPOWrapper | "[returns] cov [cov] max_var [max_var] output [sol]" | |
329365
| MinVarPOWrapper | "[returns] cov [cov] required_returns [required_returns] output [sol]" | |

0 commit comments

Comments
 (0)