sanghyunkim-seculayer/autoape-challenge2

Kaggle 2차년도(2021)

AI Competitions 2

Competitions 2차년도(2021)

Contribute

1. kaggle/dacon 안에 구조를 맞추어서, 참가한 대회 내용을 작성합니다.
2. Pull Request를 작성합니다.

Kaggle 구조

Kaggle 폴더 구조입니다.

kaggle/
├── titanic/ # 예시 대회
│  ├── metadata.yaml
│  ├── README.md
│  └── *
└── {kaggle-competition-id}/
   ├── metadata.yaml
   ├── README.md
   └── *

1. Kaggle 대회 ID로 폴더를 생성합니다.

   Kaggle 대회 ID는 URL에서 찾을 수 있습니다.

   예시 - kaggle 대회 URL이 https://www.kaggle.com/c/acea-water-prediction이면, acea-water-prediction 부분이 대회 ID입니다.

2. metadata.yaml과 README.md를 작성합니다.

   metadata에는 아래와 같은 내용들이 있어야합니다.

   version: 2
   id: kaggle-competition-id
   score: 캐글 대회 점수
   teams: 참가한 총 팀 수
   rank: 등수
   date: 대회에 제출한 날짜
   organization:
   team:
     name: 팀 이름
     members:
       - id: Kaggle ID
         name: 이름
       - id: Kaggle ID
         name: 이름

   팀 참여 예시.

   version: 2
   id: titanic
   score: 0.817
   teams: 1000
   rank: 100
   date: 2021-05-20
   organization: Hanyang University
   team:
     name: "Team Example"
     members:
       - id: User1
         name: Jone
       - id: User2
         name: 홍길동

   개인 참여 예시

   version: 2
   id: titanic
   score: 0.817
   teams: 1000
   rank: 100
   date: 2021-05-20
   organization: SecuLayer
   team:
     name: User1
     members:
       - id: User1
         name: Jone

   README.md에는 다음과 같은 내용이 있어야 합니다.

   • 결과 요약
   • 리더보드 이미지
     • 대회 점수 이미지
     • 등수 이미지
   • 알고리즘, 문제 해결 방법
   • 팀 참여 시 역할 및 기여도
   • 참고 자료
   • 기타

3. 작성했던 코드들을 생성했던 폴더에 넣습니다.

   • colab, jupyter 등을 사용했다면 ipynb을 그대로 올려도 됩니다.

4. Commit 하기

   • 팀 참여 시 commit 본문에 마지막에 Co-authored-by: name <[email protected]>를 추가하면, 한 커밋에 여러 작성자를 추가할 수 있습니다.
   • 팀 참여 git commit 커맨드 예제

    git commit -m "Refactor usability tests.
   >
   >
   Co-authored-by: name <[email protected]>
   Co-authored-by: another-name <[email protected]>"

   • 참고자료 : Creating a commit with multiple authors

참고

• YAML
  • YAML - 위키백과
• Pro Git: 6.2 GitHub - GitHub 프로젝트에 기여하기