ML4CO-Kit: Python toolkit for ML4CO
Introduction and Guidelines
Task Development Status
Generator Development Status
Solver Development Status
Optimizer Development Status
Wrapper Development Status
How to use ML4CO-Kit
API and Module
ml4co_kit
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
add_self_loop() (ml4co_kit.task.graph.base.GraphTaskBase method)
ATSP (ml4co_kit.task.base.TASK_TYPE attribute)
ATSPTask (class in ml4co_kit.task.routing.tsp.atsp)
ATT (ml4co_kit.task.routing.base.DISTANCE_TYPE attribute)
att() (ml4co_kit.task.routing.base.DisntanceEvaluator static method)
B
BA (ml4co_kit.generator.graph.base.GRAPH_TYPE attribute)
BaseEnv (class in ml4co_kit.learning.env)
BaseModel (class in ml4co_kit.learning.model)
batch_optimize() (ml4co_kit.optimizer.base.OptimizerBase method)
batch_solve() (ml4co_kit.solver.base.SolverBase method)
binormal_gen() (ml4co_kit.generator.graph.base.GraphWeightGenerator method)
BINORMIAL (ml4co_kit.generator.graph.base.GRAPH_WEIGHT_TYPE attribute)
C
cal_dist_matrix() (ml4co_kit.task.routing.base.DisntanceEvaluator method)
cal_distance() (ml4co_kit.task.routing.base.DisntanceEvaluator method)
CEIL (ml4co_kit.task.routing.base.ROUND_TYPE attribute)
check_constraints() (ml4co_kit.task.base.TaskBase method)
(ml4co_kit.task.graph.mcl.MClTask method)
(ml4co_kit.task.graph.mcut.MCutTask method)
(ml4co_kit.task.graph.mis.MISTask method)
(ml4co_kit.task.graph.mvc.MVCTask method)
(ml4co_kit.task.routing.tsp.atsp.ATSPTask method)
(ml4co_kit.task.routing.tsp.op.OPTask method)
(ml4co_kit.task.routing.tsp.pctsp.PCTSPTask method)
(ml4co_kit.task.routing.tsp.spctsp.SPCTSPTask method)
(ml4co_kit.task.routing.tsp.tsp.TSPTask method)
check_cp310_or_later() (ml4co_kit.utils.env_utils.EnvChecker method)
check_cp311_or_later() (ml4co_kit.utils.env_utils.EnvChecker method)
check_cp39_or_later() (ml4co_kit.utils.env_utils.EnvChecker method)
check_cuda() (ml4co_kit.utils.env_utils.EnvChecker method)
check_dreamplace() (ml4co_kit.utils.env_utils.EnvChecker method)
check_file_path() (in module ml4co_kit.utils.file_utils)
check_gnn4co() (ml4co_kit.utils.env_utils.EnvChecker method)
check_gurobi() (ml4co_kit.utils.env_utils.EnvChecker method)
check_torch() (ml4co_kit.utils.env_utils.EnvChecker method)
Checkpoint (class in ml4co_kit.learning.train)
compress_folder() (in module ml4co_kit.utils.file_utils)
CONCORDE (ml4co_kit.solver.base.SOLVER_TYPE attribute)
configure_optimizers() (ml4co_kit.learning.model.BaseModel method)
CVRP (ml4co_kit.task.base.TASK_TYPE attribute)
CVRP_LS (ml4co_kit.optimizer.base.OPTIMIZER_TYPE attribute)
CVRPB (ml4co_kit.task.base.TASK_TYPE attribute)
CVRPBL (ml4co_kit.task.base.TASK_TYPE attribute)
CVRPBLTW (ml4co_kit.task.base.TASK_TYPE attribute)
CVRPBTW (ml4co_kit.task.base.TASK_TYPE attribute)
CVRPL (ml4co_kit.task.base.TASK_TYPE attribute)
CVRPLSOptimizer (class in ml4co_kit.optimizer.cvrp_ls)
CVRPLTW (ml4co_kit.task.base.TASK_TYPE attribute)
CVRPTW (ml4co_kit.task.base.TASK_TYPE attribute)
D
DisntanceEvaluator (class in ml4co_kit.task.routing.base)
DISTANCE_TYPE (class in ml4co_kit.task.routing.base)
DIY (ml4co_kit.solver.base.SOLVER_TYPE attribute)
download() (in module ml4co_kit.utils.file_utils)
DREAMPLACE (ml4co_kit.solver.base.SOLVER_TYPE attribute)
E
EDAP (ml4co_kit.task.base.TASK_TYPE attribute)
EDAR (ml4co_kit.task.base.TASK_TYPE attribute)
EDATDP (ml4co_kit.task.base.TASK_TYPE attribute)
edges_to_node_pairs() (ml4co_kit.task.routing.tsp.tsp.TSPTask static method)
end() (ml4co_kit.utils.time_utils.Timer method)
EnvChecker (class in ml4co_kit.utils.env_utils)
EnvInstallHelper (class in ml4co_kit.utils.env_utils)
ER (ml4co_kit.generator.graph.base.GRAPH_TYPE attribute)
EUC_2D (ml4co_kit.task.routing.base.DISTANCE_TYPE attribute)
EUC_3D (ml4co_kit.task.routing.base.DISTANCE_TYPE attribute)
euclidean() (ml4co_kit.task.routing.base.DisntanceEvaluator static method)
evaluate() (ml4co_kit.task.base.TaskBase method)
(ml4co_kit.task.graph.mcl.MClTask method)
(ml4co_kit.task.graph.mcut.MCutTask method)
(ml4co_kit.task.graph.mis.MISTask method)
(ml4co_kit.task.graph.mvc.MVCTask method)
(ml4co_kit.task.routing.tsp.atsp.ATSPTask method)
(ml4co_kit.task.routing.tsp.op.OPTask method)
(ml4co_kit.task.routing.tsp.pctsp.PCTSPTask method)
(ml4co_kit.task.routing.tsp.spctsp.SPCTSPTask method)
(ml4co_kit.task.routing.tsp.tsp.TSPTask method)
(ml4co_kit.wrapper.base.WrapperBase method)
evaluate_w_gap() (ml4co_kit.task.base.TaskBase method)
(ml4co_kit.wrapper.base.WrapperBase method)
EXPONENTIAL (ml4co_kit.generator.graph.base.GRAPH_WEIGHT_TYPE attribute)
exponential_gen() (ml4co_kit.generator.graph.base.GraphWeightGenerator method)
extract_archive() (in module ml4co_kit.utils.file_utils)
F
FAST_2OPT (ml4co_kit.optimizer.base.OPTIMIZER_TYPE attribute)
FEM (ml4co_kit.solver.base.SOLVER_TYPE attribute)
FLOOR (ml4co_kit.task.routing.base.ROUND_TYPE attribute)
from_adj_matrix() (ml4co_kit.task.graph.base.GraphTaskBase method)
from_adj_matrix_weighted() (ml4co_kit.task.graph.base.GraphTaskBase method)
from_csr() (ml4co_kit.task.graph.base.GraphTaskBase method)
from_data() (ml4co_kit.task.base.TaskBase method)
(ml4co_kit.task.graph.base.GraphTaskBase method)
(ml4co_kit.task.routing.tsp.atsp.ATSPTask method)
(ml4co_kit.task.routing.tsp.op.OPTask method)
(ml4co_kit.task.routing.tsp.pctsp.PCTSPTask method)
(ml4co_kit.task.routing.tsp.spctsp.SPCTSPTask method)
(ml4co_kit.task.routing.tsp.tsp.TSPTask method)
from_gpickle_result() (ml4co_kit.task.graph.base.GraphTaskBase method)
from_networkx() (ml4co_kit.task.graph.base.GraphTaskBase method)
from_pickle() (ml4co_kit.task.base.TaskBase method)
(ml4co_kit.wrapper.base.WrapperBase method)
from_task_pickle_folder() (ml4co_kit.wrapper.base.WrapperBase method)
from_tsplib() (ml4co_kit.task.routing.tsp.atsp.ATSPTask method)
(ml4co_kit.task.routing.tsp.tsp.TSPTask method)
from_txt() (ml4co_kit.wrapper.base.WrapperBase method)
G
GA_EAX (ml4co_kit.solver.base.SOLVER_TYPE attribute)
GAUSSIAN (ml4co_kit.generator.graph.base.GRAPH_WEIGHT_TYPE attribute)
gaussian_gen() (ml4co_kit.generator.graph.base.GraphWeightGenerator method)
GED (ml4co_kit.task.base.TASK_TYPE attribute)
generate() (ml4co_kit.generator.base.GeneratorBase method)
(ml4co_kit.generator.graph.base.GraphWeightGenerator method)
(ml4co_kit.wrapper.base.WrapperBase method)
generate_w_to_txt() (ml4co_kit.wrapper.base.WrapperBase method)
GeneratorBase (class in ml4co_kit.generator.base)
GEO (ml4co_kit.task.routing.base.DISTANCE_TYPE attribute)
geographical() (ml4co_kit.task.routing.base.DisntanceEvaluator method)
get_data_md5() (ml4co_kit.task.base.TaskBase method)
get_md5() (in module ml4co_kit.utils.file_utils)
get_pos_layer() (in module ml4co_kit.task.graph.base)
get_schedule_fn() (in module ml4co_kit.learning.model)
get_total_num_training_steps() (ml4co_kit.learning.model.BaseModel method)
GM (ml4co_kit.task.base.TASK_TYPE attribute)
GNN4CO (ml4co_kit.solver.base.SOLVER_TYPE attribute)
GP_DEGREE (ml4co_kit.solver.base.SOLVER_TYPE attribute)
GRAPH_TYPE (class in ml4co_kit.generator.graph.base)
GRAPH_WEIGHT_TYPE (class in ml4co_kit.generator.graph.base)
GraphGeneratorBase (class in ml4co_kit.generator.graph.base)
GraphTaskBase (class in ml4co_kit.task.graph.base)
GraphWeightGenerator (class in ml4co_kit.generator.graph.base)
GUROBI (ml4co_kit.solver.base.SOLVER_TYPE attribute)
H
HGS (ml4co_kit.solver.base.SOLVER_TYPE attribute)
HK (ml4co_kit.generator.graph.base.GRAPH_TYPE attribute)
I
ILS (ml4co_kit.solver.base.SOLVER_TYPE attribute)
INSERTION (ml4co_kit.solver.base.SOLVER_TYPE attribute)
install() (ml4co_kit.utils.env_utils.EnvInstallHelper method)
ISCO (ml4co_kit.solver.base.SOLVER_TYPE attribute)
K
KAMIS (ml4co_kit.solver.base.SOLVER_TYPE attribute)
KQAP (ml4co_kit.task.base.TASK_TYPE attribute)
L
LC_DEGREE (ml4co_kit.solver.base.SOLVER_TYPE attribute)
LKH (ml4co_kit.solver.base.SOLVER_TYPE attribute)
load_data() (ml4co_kit.learning.env.BaseEnv method)
(ml4co_kit.learning.model.BaseModel method)
load_weights() (ml4co_kit.learning.model.BaseModel method)
Logger (class in ml4co_kit.learning.train)
LOGNORMAL (ml4co_kit.generator.graph.base.GRAPH_WEIGHT_TYPE attribute)
lognormal_gen() (ml4co_kit.generator.graph.base.GraphWeightGenerator method)
LP (ml4co_kit.task.base.TASK_TYPE attribute)
LQAP (ml4co_kit.task.base.TASK_TYPE attribute)
M
make_complement() (ml4co_kit.task.graph.base.GraphTaskBase method)
make_symmetric() (ml4co_kit.task.graph.base.GraphTaskBase method)
MAN_2D (ml4co_kit.task.routing.base.DISTANCE_TYPE attribute)
MAN_3D (ml4co_kit.task.routing.base.DISTANCE_TYPE attribute)
manhattan() (ml4co_kit.task.routing.base.DisntanceEvaluator static method)
MAX_2D (ml4co_kit.task.routing.base.DISTANCE_TYPE attribute)
MAX_3D (ml4co_kit.task.routing.base.DISTANCE_TYPE attribute)
maximum() (ml4co_kit.task.routing.base.DisntanceEvaluator static method)
MAXRETPO (ml4co_kit.task.base.TASK_TYPE attribute)
MCL (ml4co_kit.task.base.TASK_TYPE attribute)
MClGenerator (class in ml4co_kit.generator.graph.mcl)
MClTask (class in ml4co_kit.task.graph.mcl)
MCMC (ml4co_kit.optimizer.base.OPTIMIZER_TYPE attribute)
MCTS (ml4co_kit.optimizer.base.OPTIMIZER_TYPE attribute)
MCTSOptimizer (class in ml4co_kit.optimizer.mcts)
MCUT (ml4co_kit.task.base.TASK_TYPE attribute)
MCutGenerator (class in ml4co_kit.generator.graph.mcut)
MCutTask (class in ml4co_kit.task.graph.mcut)
MILP (ml4co_kit.task.base.TASK_TYPE attribute)
MINVARPO (ml4co_kit.task.base.TASK_TYPE attribute)
MIP (ml4co_kit.task.base.TASK_TYPE attribute)
MIS (ml4co_kit.task.base.TASK_TYPE attribute)
MISGenerator (class in ml4co_kit.generator.graph.mis)
MISTask (class in ml4co_kit.task.graph.mis)
ML4CO (ml4co_kit.solver.base.SOLVER_TYPE attribute)
ml4co_kit.generator.base
module
ml4co_kit.generator.graph.base
module
ml4co_kit.generator.graph.mcl
module
ml4co_kit.generator.graph.mcut
module
ml4co_kit.generator.graph.mis
module
ml4co_kit.generator.graph.mvc
module
ml4co_kit.generator.routing.base
module
ml4co_kit.learning.env
module
ml4co_kit.learning.model
module
ml4co_kit.learning.train
module
ml4co_kit.optimizer.base
module
ml4co_kit.optimizer.cvrp_ls
module
ml4co_kit.optimizer.mcts
module
ml4co_kit.optimizer.two_opt
module
ml4co_kit.solver.base
module
ml4co_kit.task.base
module
ml4co_kit.task.graph.base
module
ml4co_kit.task.graph.mcl
module
ml4co_kit.task.graph.mcut
module
ml4co_kit.task.graph.mis
module
ml4co_kit.task.graph.mvc
module
ml4co_kit.task.routing.base
module
ml4co_kit.task.routing.tsp
module
ml4co_kit.task.routing.tsp.atsp
module
ml4co_kit.task.routing.tsp.op
module
ml4co_kit.task.routing.tsp.pctsp
module
ml4co_kit.task.routing.tsp.spctsp
module
ml4co_kit.task.routing.tsp.tsp
module
ml4co_kit.utils.env_utils
module
ml4co_kit.utils.file_utils
module
ml4co_kit.utils.time_utils
module
ml4co_kit.utils.type_utils
module
ml4co_kit.wrapper.base
module
model_test() (ml4co_kit.learning.train.Trainer method)
model_train() (ml4co_kit.learning.train.Trainer method)
module
ml4co_kit.generator.base
ml4co_kit.generator.graph.base
ml4co_kit.generator.graph.mcl
ml4co_kit.generator.graph.mcut
ml4co_kit.generator.graph.mis
ml4co_kit.generator.graph.mvc
ml4co_kit.generator.routing.base
ml4co_kit.learning.env
ml4co_kit.learning.model
ml4co_kit.learning.train
ml4co_kit.optimizer.base
ml4co_kit.optimizer.cvrp_ls
ml4co_kit.optimizer.mcts
ml4co_kit.optimizer.two_opt
ml4co_kit.solver.base
ml4co_kit.task.base
ml4co_kit.task.graph.base
ml4co_kit.task.graph.mcl
ml4co_kit.task.graph.mcut
ml4co_kit.task.graph.mis
ml4co_kit.task.graph.mvc
ml4co_kit.task.routing.base
ml4co_kit.task.routing.tsp
ml4co_kit.task.routing.tsp.atsp
ml4co_kit.task.routing.tsp.op
ml4co_kit.task.routing.tsp.pctsp
ml4co_kit.task.routing.tsp.spctsp
ml4co_kit.task.routing.tsp.tsp
ml4co_kit.utils.env_utils
ml4co_kit.utils.file_utils
ml4co_kit.utils.time_utils
ml4co_kit.utils.type_utils
ml4co_kit.wrapper.base
MOPO (ml4co_kit.task.base.TASK_TYPE attribute)
MVC (ml4co_kit.task.base.TASK_TYPE attribute)
MVCGenerator (class in ml4co_kit.generator.graph.mvc)
MVCTask (class in ml4co_kit.task.graph.mvc)
N
NEAREST (ml4co_kit.solver.base.SOLVER_TYPE attribute)
NEUROLKH (ml4co_kit.solver.base.SOLVER_TYPE attribute)
NO (ml4co_kit.task.routing.base.ROUND_TYPE attribute)
NULL (ml4co_kit.solver.base.SOLVER_TYPE attribute)
O
OP (ml4co_kit.task.base.TASK_TYPE attribute)
OPTask (class in ml4co_kit.task.routing.tsp.op)
optimize() (ml4co_kit.optimizer.base.OptimizerBase method)
OPTIMIZER_TYPE (class in ml4co_kit.optimizer.base)
OptimizerBase (class in ml4co_kit.optimizer.base)
ORTOOLS (ml4co_kit.solver.base.SOLVER_TYPE attribute)
P
PCTSP (ml4co_kit.task.base.TASK_TYPE attribute)
PCTSPTask (class in ml4co_kit.task.routing.tsp.pctsp)
POISSON (ml4co_kit.generator.graph.base.GRAPH_WEIGHT_TYPE attribute)
poisson_gen() (ml4co_kit.generator.graph.base.GraphWeightGenerator method)
POWERLAW (ml4co_kit.generator.graph.base.GRAPH_WEIGHT_TYPE attribute)
powerlaw_gen() (ml4co_kit.generator.graph.base.GraphWeightGenerator method)
pull_file_from_huggingface() (in module ml4co_kit.utils.file_utils)
PYGM (ml4co_kit.solver.base.SOLVER_TYPE attribute)
PYSAT (ml4co_kit.solver.base.SOLVER_TYPE attribute)
PYVRP (ml4co_kit.solver.base.SOLVER_TYPE attribute)
R
RANDOM (ml4co_kit.solver.base.SOLVER_TYPE attribute)
RB (ml4co_kit.generator.graph.base.GRAPH_TYPE attribute)
remove_self_loop() (ml4co_kit.task.graph.base.GraphTaskBase method)
render() (ml4co_kit.task.base.TaskBase method)
(ml4co_kit.task.graph.mcl.MClTask method)
(ml4co_kit.task.graph.mcut.MCutTask method)
(ml4co_kit.task.graph.mis.MISTask method)
(ml4co_kit.task.graph.mvc.MVCTask method)
(ml4co_kit.task.routing.tsp.atsp.ATSPTask method)
(ml4co_kit.task.routing.tsp.op.OPTask method)
(ml4co_kit.task.routing.tsp.pctsp.PCTSPTask method)
(ml4co_kit.task.routing.tsp.spctsp.SPCTSPTask method)
(ml4co_kit.task.routing.tsp.tsp.TSPTask method)
RLSA (ml4co_kit.optimizer.base.OPTIMIZER_TYPE attribute)
(ml4co_kit.solver.base.SOLVER_TYPE attribute)
ROUND (ml4co_kit.task.routing.base.ROUND_TYPE attribute)
round_result() (ml4co_kit.task.routing.base.DisntanceEvaluator method)
ROUND_TYPE (class in ml4co_kit.task.routing.base)
RoutingGeneratorBase (class in ml4co_kit.generator.routing.base)
RoutingTaskBase (class in ml4co_kit.task.routing.base)
S
SATA (ml4co_kit.task.base.TASK_TYPE attribute)
SATP (ml4co_kit.task.base.TASK_TYPE attribute)
SCIP (ml4co_kit.solver.base.SOLVER_TYPE attribute)
shared_step() (ml4co_kit.learning.model.BaseModel method)
show_time() (ml4co_kit.utils.time_utils.Timer method)
solve() (ml4co_kit.solver.base.SolverBase method)
(ml4co_kit.wrapper.base.WrapperBase method)
SOLVER_TYPE (class in ml4co_kit.solver.base)
SolverBase (class in ml4co_kit.solver.base)
SPCTSP (ml4co_kit.task.base.TASK_TYPE attribute)
SPCTSPTask (class in ml4co_kit.task.routing.tsp.spctsp)
split_txt_file() (in module ml4co_kit.utils.file_utils)
start() (ml4co_kit.utils.time_utils.Timer method)
swap_sol_and_ref_sol() (ml4co_kit.wrapper.base.WrapperBase method)
T
TASK_TYPE (class in ml4co_kit.task.base)
TaskBase (class in ml4co_kit.task.base)
test_dataloader() (ml4co_kit.learning.env.BaseEnv method)
(ml4co_kit.learning.model.BaseModel method)
test_step() (ml4co_kit.learning.model.BaseModel method)
Timer (class in ml4co_kit.utils.time_utils)
to_adj_matrix() (ml4co_kit.task.graph.base.GraphTaskBase method)
to_chszlablib() (ml4co_kit.task.graph.base.GraphTaskBase method)
to_csr() (ml4co_kit.task.graph.base.GraphTaskBase method)
to_gpickle_result() (ml4co_kit.task.graph.base.GraphTaskBase method)
to_networkx() (ml4co_kit.task.graph.base.GraphTaskBase method)
to_numpy() (in module ml4co_kit.utils.type_utils)
to_pickle() (ml4co_kit.task.base.TaskBase method)
(ml4co_kit.wrapper.base.WrapperBase method)
to_task_pickle_folder() (ml4co_kit.wrapper.base.WrapperBase method)
to_tensor() (in module ml4co_kit.utils.type_utils)
to_tsplib() (ml4co_kit.task.routing.tsp.atsp.ATSPTask method)
(ml4co_kit.task.routing.tsp.tsp.TSPTask method)
to_txt() (ml4co_kit.wrapper.base.WrapperBase method)
tqdm_by_time() (in module ml4co_kit.utils.time_utils)
train_dataloader() (ml4co_kit.learning.env.BaseEnv method)
(ml4co_kit.learning.model.BaseModel method)
Trainer (class in ml4co_kit.learning.train)
training_step() (ml4co_kit.learning.model.BaseModel method)
TSP (ml4co_kit.task.base.TASK_TYPE attribute)
TSPTask (class in ml4co_kit.task.routing.tsp.tsp)
TWO_OPT (ml4co_kit.optimizer.base.OPTIMIZER_TYPE attribute)
TwoOptOptimizer (class in ml4co_kit.optimizer.two_opt)
U
UNIFORM (ml4co_kit.generator.graph.base.GRAPH_WEIGHT_TYPE attribute)
uniform_gen() (ml4co_kit.generator.graph.base.GraphWeightGenerator method)
V
val_dataloader() (ml4co_kit.learning.env.BaseEnv method)
(ml4co_kit.learning.model.BaseModel method)
validation_step() (ml4co_kit.learning.model.BaseModel method)
W
WrapperBase (class in ml4co_kit.wrapper.base)
WS (ml4co_kit.generator.graph.base.GRAPH_TYPE attribute)