kc-ml2 / snl-starter-kit

SNL에 참여 하기위한 stater kit 입니다.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

snl-starter-kit

SNL에 참여하기 위한 starter kit 입니다.

Prerequisite

  • SNL account
  • Docker Engine(엔진이 꼭!! 켜져 있어야 합니다)
    • tested on CentOS, Ubuntu, MacOS
  • openmpi(만약 시스템에 설치되어 있지 않다면) for mpi4py
    • Ubuntu : sudo apt-get install libopenmpi-dev
    • CentOS/RHEL : sudo yum install openmpi-devel
    • Mac : (필요시)(대부분의 경우에 이미 설치되어 있음)brew install mpich
    • 경우에 따라 환경변수 설정 등이 필요할 수도 있기 때문에, 환경에 맞는 설치방법을 구글링하여 설치.
  • 패키지 설치
pip install -r requirements.txt

How-To

Directories

snl-starter-kit/
  /src
  /submit.sh

src 폴더안의 algo에 본인의 에이전트를 구현하시면 됩니다.

  • Agent class에 act method는 꼭 정의되어 있어야 합니다.
  • Agent.act 메소드의 인자로 환경의 observation이 들어옵니다. observation의 디테일은 comment 혹은 https://github.com/kc-ml2/marlenv를 참조 부탁드립니다.
class Agent:
    def __init__(self):
        pass

    def act(self, obs):
        pass
  • Inference(혹은 test) time을 위한 파라미터로, 초기화된 agent instance를 agent_factory 메소드에서 return 해주셔야 합니다.
  • 예를 들어, Epsilon greedy exploration을 하는 agent의 경우, test time에서는 exploration을 원치 않을 때, explore=False
def agent_factory():
    agent = Agent(**kwargs_for_inference)

    return agent
  • 에이전트 제출
# log in with your account info
docker login


# below script will build and push docker image
./submit.sh

# 만약 ./submit.sh가 실행 안될경우
sudo chmod 777 submit.sh

Notes

도커

용량 부족

  • 도커 엔진은 사용할 수 있는 저장공간이 제한되어 있습니다. 이미 엔진에 너무 많은 이미지가 있는 경우, 불필요한 이미지를 정리해주시고 docker system prune실행해 주세요.

메모리 부족

  • 도커 엔진은 사용할 수 있는 메모리공간이 제한되어 있습니다. 이미지를 build 할 때 간혹 메모리가 부족하다고 뜰 경우, 도커 엔진이 사용할 수 있는 메모리를 늘려 주시기 바랍니다.

Window 사용자

Tested on Python 3.7, Docker Engine backed by WSL

PowerShell or git-bash로 submit.sh 실행(관리자 권한 필요 없습니다.) .₩submit.sh 혹은 sub타입후 탭

  • Pycharm등의 IDE terminal에서는 그냥 submit.sh

  • submit.sh 실행 중 권한 요청이 오면 수락

About

SNL에 참여 하기위한 stater kit 입니다.


Languages

Language:Jupyter Notebook 78.5%Language:Python 19.0%Language:Shell 2.2%Language:Dockerfile 0.2%