HUANG1993 commited on
Commit
fddb5a0
1 Parent(s): 1d90dd1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +19 -13
README.md CHANGED
@@ -13,7 +13,6 @@ tags:
13
 
14
  # 🤠GreedRL
15
 
16
-
17
  ## Introduction
18
 
19
  ***Combinatorial Optimization Problems(COPs)*** has long been an active field of research. Generally speaking, there exists two main approachs for solving COPs, each of them having pros and cons. On the one hand, the *exact algorithms* can find the optimal solution, but they may be prohibitive for solving large instances because of the exponential increate of the execution time.
@@ -24,6 +23,9 @@ tags:
24
 
25
  ## 🏆Award
26
 
 
 
 
27
  ## Main features
28
 
29
  * **GENERAL**
@@ -44,7 +46,8 @@ tags:
44
  ## COPs Modeling examples
45
 
46
 
47
- ### Capacitated Vehicle Routing Problem (CVRP)
 
48
  <details>
49
  <summary>CVRP</summary>
50
 
@@ -551,19 +554,24 @@ class Objective:
551
 
552
  </details>
553
 
554
- #
 
555
 
556
  # GreedRL-CVRP-pretrained model
557
 
558
 
559
  ## Model description
560
 
 
561
 
 
562
 
563
 
564
  ## Intended uses & limitations
565
 
566
- You can use these model for solving the vehicle routing problems (VRPs) with reinforcement learning (RL).
 
 
567
 
568
  ## How to use
569
 
@@ -574,7 +582,7 @@ This library requires Python == 3.8. [Miniconda](https://docs.conda.io/en/latest
574
  pip install torch==1.12.1+cu113 torchvision==0.13.1+cu113 torchaudio==0.12.1 --extra-index-url https://download.pytorch.org/whl/cu113
575
  ```
576
 
577
- You need to compile first and add the resulting library `greedrl_c` to the `PYTHONPATH`
578
 
579
  ```aidl
580
  python setup.py build
@@ -585,13 +593,9 @@ export PYTHONPATH={root_path}/greedrl/build/lib.linux-x86_64-cpython-38/:$PYTHON
585
 
586
  ### Training
587
 
588
- We provide example of Capacitated VRP(CVRP) for training and inference.
589
-
590
  1. Training data
591
 
592
- We use the generated data for the training phase, the customers and depot locations are randomly generated in the unit square [0,1] X [0,1].
593
-
594
- For the CVRP, we assume that the demand of each node is a discrete number in {1,...,9}, chosen uniformly at random.
595
 
596
 
597
  2. Start training
@@ -601,9 +605,9 @@ cd examples/cvrp
601
  python train.py --model_filename cvrp_5000.pt --problem_size 5000
602
  ```
603
 
604
- ### Evaluation
605
 
606
- We provide some pretrained models for different CVRP problem sizes, such as `cvrp_100`, `cvrp_1000`, `cvrp_2000` and `cvrp_5000`, that you can directly use for inference.
607
 
608
  ```python
609
  cd examples/cvrp
@@ -612,7 +616,9 @@ python solve.py --device cuda --model_name cvrp_5000.pt --problem_size 5000
612
  ```
613
 
614
  ## Support
615
- For commercial enquiries, please contact [us](huangxuankun.hxk@cainiao.com).
 
 
616
 
617
  ## About GreedRL
618
  - Website: https://greedrl.github.io/
 
13
 
14
  # 🤠GreedRL
15
 
 
16
  ## Introduction
17
 
18
  ***Combinatorial Optimization Problems(COPs)*** has long been an active field of research. Generally speaking, there exists two main approachs for solving COPs, each of them having pros and cons. On the one hand, the *exact algorithms* can find the optimal solution, but they may be prohibitive for solving large instances because of the exponential increate of the execution time.
 
23
 
24
  ## 🏆Award
25
 
26
+ [INFORMS 2021 Franz Edelman Award finalists]( (https://www.informs.org/Resource-Center/Video-Library/Edelman-Competition-Videos/2021-Edelman-Competition-Videos/2021-Edelman-Finalist-Alibaba)) for Achievement in Operations Research and the Management Sciences (recognized for our work on Cainiao Network VRP algorithm).
27
+
28
+
29
  ## Main features
30
 
31
  * **GENERAL**
 
46
  ## COPs Modeling examples
47
 
48
 
49
+ ###
50
+ Capacitated Vehicle Routing Problem (CVRP)
51
  <details>
52
  <summary>CVRP</summary>
53
 
 
554
 
555
  </details>
556
 
557
+ ## Pricing
558
+
559
 
560
  # GreedRL-CVRP-pretrained model
561
 
562
 
563
  ## Model description
564
 
565
+ We are delighted to release 🤠GreedRL Community Edition, as well as pretrained models, which are specialized to CVRP with problem size ranging from 100 to 5000 nodes.
566
 
567
+ The model is trained using a deep reinforcement learning(DRL) algorithm known as REINFORCE. The model consists of two main components, an Encoder and a Decoder. The encoder produces embedding of all input nodes. The decoder then generates a solution sequence autoregressively. Feasibility of the solution is ensured by a *mask* procedure that prevents the model from selecting nodes that would result in a violation of constraints, e.g. exceeding the vehicle capacity.
568
 
569
 
570
  ## Intended uses & limitations
571
 
572
+ You can use these default models for solving the Capacitated VRP(CVRP) with deep reinforcement learning(DRL).
573
+
574
+ These model is limited by its training dataset, this may not generalize well for all use cases in different domains.
575
 
576
  ## How to use
577
 
 
582
  pip install torch==1.12.1+cu113 torchvision==0.13.1+cu113 torchaudio==0.12.1 --extra-index-url https://download.pytorch.org/whl/cu113
583
  ```
584
 
585
+ You need to compile first and add the resulting library `greedrl` to the `PYTHONPATH`
586
 
587
  ```aidl
588
  python setup.py build
 
593
 
594
  ### Training
595
 
 
 
596
  1. Training data
597
 
598
+ We use generated data for the training phase, the customers and depot locations are randomly generated in the unit square [0,1] X [0,1]. For CVRP, we assume that the demand of each node is a discrete number in {1,...,9}, chosen uniformly at random.
 
 
599
 
600
 
601
  2. Start training
 
605
  python train.py --model_filename cvrp_5000.pt --problem_size 5000
606
  ```
607
 
608
+ ### Inference
609
 
610
+ We provide some pretrained models for different CVRP problem sizes, such as `cvrp_100` , `cvrp_1000` , `cvrp_2000` and `cvrp_5000`, that you can directly use for inference.
611
 
612
  ```python
613
  cd examples/cvrp
 
616
  ```
617
 
618
  ## Support
619
+ We look forward you to downloading it, using it, and opening discussion if you encounter any problems or have ideas on building an even better experience.
620
+
621
+ For commercial enquiries, please contact [us](jiangwen.wjw@alibaba-inc.com).
622
 
623
  ## About GreedRL
624
  - Website: https://greedrl.github.io/