jeonghyo.k
3946ff6a25
- prediction/image/ FastAPI 서버 Docker 환경 구성 - Dockerfile: PyTorch 2.1 + CUDA 12.1 기반 GPU 이미지 - docker-compose.yml: GPU 할당 + 데이터 볼륨 마운트 - requirements.txt: 서버 의존성 목록 - .env.example: 환경변수 템플릿 - DOCKER_USAGE.md: 빌드/실행/API 사용법 문서 - Dockerfile에 .dockerignore 제외 폴더 mkdir -p 추가 - .gitignore: prediction/image 결과물 및 모델 가중치(.pth) 제외 추가 - dbInsert_csv.py, dbInsert_shp.py 삭제 (미사용 DB 로직) - api.py: dbInsert import 및 주석 처리된 DB 호출 코드 제거 - aerialRouter.ts: req.params 타입 오류 수정
59 lines
1.8 KiB
Markdown
59 lines
1.8 KiB
Markdown
# Contributing to mmsegmentation
|
|
|
|
All kinds of contributions are welcome, including but not limited to the following.
|
|
|
|
- Fixes (typo, bugs)
|
|
- New features and components
|
|
|
|
## Workflow
|
|
|
|
1. fork and pull the latest mmsegmentation
|
|
2. checkout a new branch (do not use master branch for PRs)
|
|
3. commit your changes
|
|
4. create a PR
|
|
|
|
:::{note}
|
|
|
|
- If you plan to add some new features that involve large changes, it is encouraged to open an issue for discussion first.
|
|
- If you are the author of some papers and would like to include your method to mmsegmentation,
|
|
please contact Kai Chen (chenkaidev\[at\]gmail\[dot\]com). We will much appreciate your contribution.
|
|
:::
|
|
|
|
## Code style
|
|
|
|
### Python
|
|
|
|
We adopt [PEP8](https://www.python.org/dev/peps/pep-0008/) as the preferred code style.
|
|
|
|
We use the following tools for linting and formatting:
|
|
|
|
- [flake8](http://flake8.pycqa.org/en/latest/): linter
|
|
- [yapf](https://github.com/google/yapf): formatter
|
|
- [isort](https://github.com/timothycrosley/isort): sort imports
|
|
|
|
Style configurations of yapf and isort can be found in [setup.cfg](../setup.cfg) and [.isort.cfg](../.isort.cfg).
|
|
|
|
We use [pre-commit hook](https://pre-commit.com/) that checks and formats for `flake8`, `yapf`, `isort`, `trailing whitespaces`,
|
|
fixes `end-of-files`, sorts `requirments.txt` automatically on every commit.
|
|
The config for a pre-commit hook is stored in [.pre-commit-config](../.pre-commit-config.yaml).
|
|
|
|
After you clone the repository, you will need to install initialize pre-commit hook.
|
|
|
|
```shell
|
|
pip install -U pre-commit
|
|
```
|
|
|
|
From the repository folder
|
|
|
|
```shell
|
|
pre-commit install
|
|
```
|
|
|
|
After this on every commit check code linters and formatter will be enforced.
|
|
|
|
> Before you create a PR, make sure that your code lints and is formatted by yapf.
|
|
|
|
### C++ and CUDA
|
|
|
|
We follow the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
|