Update README (#7)

Author: mental2008

Makefile

@@ -1,8 +1,18 @@
 OUTPUT_DIR=./bin
+
+GOARCH ?= $(shell go env GOARCH)
+GOOS ?= $(shell go env GOOS)
+
 BINARY_NAME=simon
 LINUX_BINARY_NAME=simon_linux
 DARWIN_BINARY_NAME=simon_darwin
 
+all: build
+
+.PHONY: build
+build:
+	GOARCH=$(GOARCH) GOOS=$(GOOS) go build -v -o $(OUTPUT_DIR)/$(BINARY_NAME) ./cmd
+
 .PHONY: darwin_build
 darwin_build:
 	GOARCH=amd64 GOOS=darwin go build -v -o $(OUTPUT_DIR)/$(DARWIN_BINARY_NAME) ./cmd
@@ -19,4 +29,4 @@ linux_build:
 
 .PHONY: clean_build
 clean_build:
-	rm -f $(OUTPUT_DIR)/*
+	rm -f $(OUTPUT_DIR)/*

README.md

@@ -2,25 +2,50 @@
 
 Please ensure that Go is installed.
 
-`go mod vendor` will install the dependencies required for the simulator, and `make` will generate the compiled binary fils in the `bin` directory.
+`go mod vendor` installs the dependencies required for the simulator. 
 
 ```bash
 $ go mod vendor
-$ make local_build
-$ make linux_build
 ```
 
-## 🔥 Quick Start
+`make` generates the compiled binary files in the `bin` directory.
 
 ```bash
-$  LOGLEVEL=DEBUG bin/simon apply --extended-resources "gpu" -s example/test-scheduler-config.yaml -f example/test-cluster-config.yaml
+$ make
+```
+
+## 🔥 Quickstart Example
+
+The following example will schedule 6 test pods onto a cluster with 2 nodes, and the expected output will show the allocation ratio of each resource dimension (CPU, memory, GPU).
+
+```bash
+$ bin/simon apply --extended-resources "gpu" \
+                  -f example/test-cluster-config.yaml \
+                  -s example/test-scheduler-config.yaml
 ```
 
 ## 🔮 Experiments
 
 TBD.
 
+## 📝 Paper
+
+Please cite our paper if it is helpful to your research.
+
+```
+@inproceedings{FGD,
+title = {Beware of Fragmentation: Scheduling GPU-Sharing Workloads with Fragmentation Gradient Descent},
+author = {Qizhen Weng and Lingyun Yang and Yinghao Yu and Wei Wang and Xiaochuan Tang and Guodong Yang and Liping Zhang},
+booktitle = {2023 {USENIX} Annual Technical Conference},
+year = {2023},
+series = {{USENIX} {ATC} '23}
+url = {https://www.usenix.org/conference/atc23/presentation/weng},
+publisher = {{USENIX} Association},
+}
+```
+
 ## 🙏🏻 Acknowledge
 
-Our simulator is developed based on [Alibaba's open-simulator](https://github.com/alibaba/open-simulator), a simulator used for cluster capacity planning. 
-The GPU-related plugin has been incorporated into its main branch.
+Our simulator is developed based on [open-simulator](https://github.com/alibaba/open-simulator) by Alibaba, a simulator used for cluster capacity planning. 
+This repository primarily evaluates the performance of different scheduling polices on production traces.
+GPU-related plugin has been merged into the main branch of [open-simulator](https://github.com/alibaba/open-simulator).

data/README.md

@@ -1,6 +1,17 @@
 # Traces as Inputs for Simulator
 
-## Usage
+## 🚧 Environment Setup
+
+Install the required Python dependency environment.
+
+```bash
+$ pip install -r requirements.txt
+```
+
+## 🛠 Usage
+
+Generate the YAML files needed for the simulation experiment based on the original CSV files.
+
 ```bash
-bash prepare_input.sh
+$ bash prepare_input.sh
 ```

data/requirements.txt

@@ -0,0 +1,7 @@
+numpy==1.24.3
+pandas==2.0.1
+python-dateutil==2.8.2
+pytz==2023.3
+PyYAML==6.0
+six==1.16.0
+tzdata==2023.3

example/test-scheduler-config.yaml

@@ -37,10 +37,10 @@ profiles:
     pluginConfig:
       - name: FGDScore
         args:
-          dimExtMethod: merge
+          dimExtMethod: share
           normMethod: max
       - name: Open-Gpu-Share
         args:
-          dimExtMethod: merge
+          dimExtMethod: share
           normMethod: max
           gpuSelMethod: FGDScore