Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme #164

Merged
merged 2 commits into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
- [API服务部署](#️-部署-api-服务)
- [Docker部署](#-docker-部署)
- [联系我们](#-联系我们)
- [Q&A](#qa)
- [FAQ](#faq)
- [贡献者](#贡献者)
- [感谢支持](#感谢支持)
- [License](#lincese)
Expand Down Expand Up @@ -153,6 +153,8 @@ python scripts/download_model.py --models all
| rmbg-1.4 | [BRIA AI](https://huggingface.co/briaai/RMBG-1.4) 开源的抠图模型 | [下载](https://huggingface.co/briaai/RMBG-1.4/resolve/main/onnx/model.onnx?download=true)(176.2MB)后重命名为`rmbg-1.4.onnx` |
| birefnet-v1-lite | [ZhengPeng7](https://github.com/ZhengPeng7/BiRefNet) 开源的抠图模型,拥有最好的分割精度 | [下载](https://github.com/ZhengPeng7/BiRefNet/releases/download/v1/BiRefNet-general-bb_swin_v1_tiny-epoch_232.onnx)(224MB)后重命名为`birefnet-v1-lite.onnx` |

> 如果下载网速不顺利:前往[SwanHub](https://swanhub.co/ZeYiLin/HivisionIDPhotos_models/tree/main)下载。


## 4. 人脸检测模型配置(可选)

Expand Down Expand Up @@ -374,7 +376,7 @@ docker run -d -p 7860:7860 \
<br>


# Q&A
# FAQ

## 1. 如何修改预设尺寸和颜色?

Expand All @@ -394,6 +396,9 @@ docker run -d -p 7860:7860 \

<img src="assets/social_template.png" width="500">

## 4. 如何修改Gradio Demo的顶部导航栏?

- 修改`demo/assets/title.md`

<br>

Expand Down
4 changes: 4 additions & 0 deletions README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,10 @@ docker run -d -p 7860:7860 \

<img src="assets/social_template.png" width="500">

## 4. How to Modify the Top Navigation Bar of the Gradio Demo?

- Modify the `demo/assets/title.md` file.

<br>

# 📧 Contact Us
Expand Down
26 changes: 19 additions & 7 deletions README_JP.md
Original file line number Diff line number Diff line change
Expand Up @@ -358,17 +358,29 @@ docker run -d -p 7860:7860 \

<br>

# 💻 開発のヒント
# よくある質問 (FAQ)

## どのようにデフォルトのサイズと色を変更しますか
## 1. 基本的なサイズと色をどのように変更しますか

- サイズ:`size_list_EN.csv`を修正した後、再度`app.py`を実行すれば、第一列がサイズ名、第二列が高さ、第三列が幅になります
- 色:`color_list_EN.csv`を修正した後、再度`app.py`を実行すれば、第一列が色名、第二列がHex値になります
- サイズ: [size_list_EN.csv](demo/assets/size_list_EN.csv) ファイルを修正した後、`app.py`を再実行すれば大丈夫です。最初の列はサイズ名、二番目の列は高さ、三番目の列は幅です
- 色: [color_list_EN.csv](demo/assets/color_list_EN.csv) ファイルを修正した後、`app.py`を再実行すれば大丈夫です。最初の列は色名、二番目の列はHex値です

## ウォーターマークフォントの変更方法
## 2. ウォーターマークのフォントをどのように変更しますか?

1. フォントファイルを `hivision/plugin/font` フォルダーに配置します。
2. `hivision/plugin/watermark.py` の `font_file` パラメータの値をフォントファイルの名前に変更します。
1. フォントファイルを`hivision/plugin/font`フォルダーに置きます。
2. `hivision/plugin/watermark.py`ファイル内の`font_file`パラメータの値をフォントファイル名に変更します。

## 3. ソーシャルメディアのテンプレート画像をどのように追加しますか?

1. テンプレート画像を`hivision/plugin/template/assets`フォルダーに置きます。テンプレート画像は4チャンネルの透明PNGです。
2. `hivision/plugin/template/assets/template_config.json`ファイルに最新のテンプレート情報を追加します。ここで`width`はテンプレート画像の幅(px)、`height`はテンプレート画像の高さ(px)、`anchor_points`はテンプレートの透明領域の4つの隅の座標(px)です。`rotation`は透明領域の垂直方向に対する回転角度で、>0は反時計回り、<0は時計回りです。
3. `demo/processor.py`の`_generate_image_template`関数内の`TEMPLATE_NAME_LIST`変数に最新のテンプレート名を追加します。

<img src="assets/social_template.png" width="500">

## 4. Gradio Demoの上部ナビゲーションバーをどのように変更しますか?

- `demo/assets/title.md`ファイルを修正します。

<br>

Expand Down
22 changes: 17 additions & 5 deletions README_KO.md
Original file line number Diff line number Diff line change
Expand Up @@ -360,17 +360,29 @@ docker run -d -p 7860:7860 \

<br>

# 💻 개발 팁
# 자주 묻는 질문 (FAQ)

## 기본 크기와 색상을 어떻게 수정하나요?**
## 1. 기본 크기와 색상을 어떻게 수정하나요?

- 크기: [size_list_EN.csv](demo/assets/size_list_EN.csv) 파일을 수정한 후 `app.py`를 다시 실행하면 됩니다. 첫 번째 열은 크기 이름, 두 번째 열은 높이, 세 번째 열은 너비입니다.
- 색상: [color_list_EN.csv](demo/assets/color_list_EN.csv) 파일을 수정한 후 `app.py`를 다시 실행하면 됩니다. 첫 번째 열은 색상 이름, 두 번째 열은 Hex 값입니다.

## 워터마크 폰트 변경 방법
## 2. 워터마크 글꼴을 어떻게 수정하나요?

1. 폰트 파일을 `hivision/plugin/font` 폴더에 배치합니다.
2. `hivision/plugin/watermark.py`의 `font_file` 매개변수 값을 폰트 파일 이름으로 변경합니다.
1. 글꼴 파일을 `hivision/plugin/font` 폴더에 넣습니다.
2. `hivision/plugin/watermark.py` 파일에서 `font_file` 매개변수 값을 글꼴 파일 이름으로 수정합니다.

## 3. 소셜 미디어 템플릿 사진을 어떻게 추가하나요?

1. 템플릿 이미지를 `hivision/plugin/template/assets` 폴더에 넣습니다. 템플릿 이미지는 4채널 투명 PNG입니다.
2. `hivision/plugin/template/assets/template_config.json` 파일에 최신 템플릿 정보를 추가합니다. 여기서 `width`는 템플릿 이미지의 너비(px), `height`는 템플릿 이미지의 높이(px), `anchor_points`는 템플릿의 투명 영역 네 모서리의 좌표(px)입니다. `rotation`은 투명 영역의 수직 방향에 대한 회전 각도로, >0은 반시계 방향, <0은 시계 방향입니다.
3. `demo/processor.py`의 `_generate_image_template` 함수 내의 `TEMPLATE_NAME_LIST` 변수에 최신 템플릿 이름을 추가합니다.

<img src="assets/social_template.png" width="500">

## 4. Gradio Demo의 상단 내비게이션 바를 어떻게 수정하나요?

- `demo/assets/title.md` 파일을 수정합니다.

<br>

Expand Down