# DI-orchestrator

**Repository Path**: opendilab/DI-orchestrator

## Basic Information

- **Project Name**: DI-orchestrator
- **Description**: OpenDILab强化学习容器化调度和协调框架
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 14
- **Forks**: 5
- **Created**: 2021-10-08
- **Last Updated**: 2022-10-12

## Categories & Tags

**Categories**: machine-learning

**Tags**: None

## README

[![Build](https://github.com/opendilab/DI-orchestrator/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/opendilab/DI-orchestrator/actions/workflows/build.yaml) [![Releases](https://github.com/opendilab/DI-orchestrator/actions/workflows/release.yaml/badge.svg)](https://github.com/opendilab/DI-orchestrator/actions/workflows/release.yaml)
# DI Orchestrator
DI Orchestrator is designed to manage DI (Decision Intelligence) jobs using Kubernetes Custom Resource and Operator. 

### Prerequisites
- A well-prepared kubernetes cluster. Follow the [instructions](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm/) to create a kubernetes cluster, or create a local kubernetes node referring to [kind](https://kind.sigs.k8s.io/docs/user/quick-start/) or [minikube](https://minikube.sigs.k8s.io/docs/start/)
- Cert-manager. Installation on kubernetes please refer to [cert-manager docs](https://cert-manager.io/docs/installation/kubernetes/). Or you can install it by the following command.
```bash
kubectl create -f ./config/certmanager/cert-manager.yaml
```

### Install DI Orchestrator
DI Orchestrator consists of three components: `di-operator`, `di-webhook` and `di-server`. Install them with the following command.
```bash
kubectl create -f ./config/di-manager.yaml
```

`di-operator`, `di-webhook` and `di-server` will be installed in `di-system` namespace. 
```bash
$ kubectl get pod -n di-system
NAME                               READY   STATUS    RESTARTS   AGE
di-operator-57cc65d5c9-5vnvn       1/1     Running   0          59s
di-server-7b86ff8df4-jfgmp         1/1     Running   0          59s
di-webhook-45jgi23fhc-9yght        1/1     Running   0          59s
```

### Install AggregatorConfig
Since all DIJobs share the same configuration of aggregator, we define aggregator template in AggregatorConfig.
Install AggregatorConfig with the following command:
```bash
kubectl create -f config/samples/agconfig.yaml -n di-system
```
### Submit DIJob
```bash
# submit DIJob
$ kubectl create -f config/samples/dijob-cartpole.yaml

# get pod and you will see coordinator is created by di-operator
# a few seconds later, you will see collectors and learners created by di-server
$ kubectl get pod

# get logs of coordinator
$ kubectl logs cartpole-dqn-coordinator
```

## User Guide
Refers to [user-guide](./docs/architecture.md). For Chinese version, please refer to [中文手册](./docs/architecture-cn.md)

## Contributing
Refers to [developer-guide](./docs/developer-guide.md). 

Contact us throw <opendilab.contact@gmail.com>