- 빌드 페이지 : https://pseudo-lab.github.io/SegCrew-Book
- reference1: https://github.com/Pseudo-Lab/Jupyter-Book-Template
- reference2: https://github.com/Pseudo-Lab/pytorch-guide
-
init
- 페이지 작성은
.md
,.ipynb
형식으로 작성
- 페이지 작성은
-
git clone
-
git clone https://github.com/Pseudo-Lab/SegCrew-Book.git
-
-
페이지 작성 파일 이동
SegCrew-Book/book/docs
에 위치시킬 것ch1
폴더 내에 작성
-
_toc.yml
변경-
SegCrew-Book/book
내_toc.yml
파일 변경 -
format: jb-book root: docs/index chapters: - file: docs/ch0/00 Survey sections: - file: docs/ch0/Survey-Semantic - file: docs/ch0/Survey-Instance - file: docs/ch0/Survey-Panoptic - file: docs/ch0/Survey-WeaklySemi - file: docs/ch1/01 Semantic Segmentation sections: - file: docs/ch1/fcn - file: docs/ch2/02 Instance Segmentation - file: docs/ch3/03 Panoptic Segmentation - file: docs/ch4/04 Weakly-supervised Segmentation - file: docs/ch5/05 Semi-supervised Segmentation
-
위 코드 참조하여 추가한 페이지 이름 변경
-
-
Jupyter book 설치
-
pip install -U jupyter-book
-
-
폴더 이동
-
cd pytorch-guide
-
-
(로컬) Jupyter book build
-
jupyter-book build book/
-
cmd 창 내
Or paste this line directly into your browser bar:
이하의 링크를 사용하면 로컬에서 jupyter book 을 빌드할 수 있음
-
-
(온라인) Jupyter book build
-
변경 내용 push 할 것
-
pip install ghp-import ghp-import -n -p -f book/_build/html -m "20-08-09 publishing"
-
[jupyter-book syntax]
https://jupyterbook.org/reference/cheatsheet.html#myst-syntax-cheat-sheet
- 제목은 리뷰하고자 하는 논문의 nickname또는 논문 제목과 투고된 학회/학술지 명을 다음과 같은 양식으로 기재한다.
{"NickName or 제목"} - {"학회/학술지 명"}
- 본문 최상단에 논문 정보를 기재한다.
- Jupyter-book의 "admonition" block에 다음과 같은 양식으로 기입한다.
- review 항목은 openReview 등 정식 리뷰 결과에 한정하여 기입한다.
```{admonition} Information
- **Title:** {논문 제목}, {학회/학술지명}
- **Reference**
- Paper: [{논문 링크}]({논문 링크})
- Code: [{code 링크}]({code 링크})
- Review: [{review 링크}]({review 링크})
- **Review By:** {리뷰 작성자 기입}
- **Edited by:** {리뷰 편집자 기입}
- **Last updated on {최종 update 날짜 e.g. Jan. 5, 2022}**
3. 본문에 image를 추가하는 경우 다음 format을 이용한다.
- figure-tag는 본문의 referencing을 위해 다른 그림과 구분될 수 있는 값으로 지정한다.
- 아카이브 cite No.를 기준으로 출처를 기입한다. e.g. arXiv:1803.10464
```plaintext
:::{figure-md} 'tag명'
<img src="{주소}" alt="{tag명}" class="bg-primary mb-1" width="{800px}">
{제목} \ (source: {출처})
:::
- 논문의 표를 image로 추가하는 경우 다음 양식을 활용한다.
```{image} pic/affinitynet/aff9.png
:alt: aff9.png
:class: bg-primary mb-1
:align: center
:width: 800