Spaces:
Sleeping
Sleeping
iris-s-coon
commited on
Commit
โข
6d2f815
1
Parent(s):
797cbc8
๐ [docs] ่ฑ่ชREADMEใฎๆดๆฐ
Browse files- docs/README.en.md +20 -17
docs/README.en.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1 |
---
|
2 |
license: mit
|
3 |
-
title:
|
4 |
sdk: streamlit
|
5 |
emoji: ๐จ
|
6 |
colorFrom: blue
|
@@ -28,11 +28,11 @@ app_file: pic_to_header/app.py
|
|
28 |
|
29 |
</div>
|
30 |
|
31 |
-
Pic-to-Header is a Python application that generates header images using a mask image and an input image. Version 0.
|
32 |
|
33 |
## ๐ Project Overview
|
34 |
|
35 |
-
Pic-to-Header is a Streamlit application that allows you to easily generate and download header images using a mask image and an input image. It's also available on PyPI.
|
36 |
|
37 |
|
38 |
## ๐ฅ Demo Video
|
@@ -42,7 +42,7 @@ https://github.com/user-attachments/assets/9306ad92-9a2e-45d7-9004-0eba9c0e1207
|
|
42 |
|
43 |
## ๐ค Demo Site
|
44 |
|
45 |
-
<!-- Spaces
|
46 |
[![Spaces](https://img.shields.io/badge/๐ค%20Hugging%20Face-Spaces-yellow.svg)](https://huggingface.co/spaces/MakiAi/pic-to-header)
|
47 |
|
48 |
## โจ Key Features
|
@@ -51,7 +51,10 @@ https://github.com/user-attachments/assets/9306ad92-9a2e-45d7-9004-0eba9c0e1207
|
|
51 |
- Generate header images
|
52 |
- Preview and download generated header images
|
53 |
- Image processing using a command-line interface (CLI)
|
54 |
-
-
|
|
|
|
|
|
|
55 |
|
56 |
|
57 |
## ๐ง Usage
|
@@ -78,14 +81,14 @@ pip install pic-to-header
|
|
78 |
|
79 |
### Streamlit Web Application
|
80 |
|
81 |
-
1.
|
82 |
```bash
|
83 |
streamlit run pic_to_header/app.py
|
84 |
```
|
85 |
2. Access the URL displayed in your browser.
|
86 |
-
3. Upload the input and mask
|
87 |
4. Click the "Generate Header Image" button.
|
88 |
-
5. Preview the generated header image and download it if
|
89 |
|
90 |
|
91 |
### Command-Line Interface (CLI)
|
@@ -102,9 +105,9 @@ Example:
|
|
102 |
pic-to-header assets/sample.png assets/mask.png output_image.png
|
103 |
```
|
104 |
|
105 |
-
### Using
|
106 |
|
107 |
-
The `
|
108 |
|
109 |
```python
|
110 |
from pic_to_header.core import process_header_image
|
@@ -131,7 +134,7 @@ Running this script will generate the header image at the specified output path.
|
|
131 |
|
132 |
## ๐ป Development
|
133 |
|
134 |
-
- `pic_to_header/core.py`: Contains the main image processing
|
135 |
- `pic_to_header/app.py`: Provides the web interface using Streamlit.
|
136 |
- `pic_to_header/cli.py`: Provides the command-line interface.
|
137 |
|
@@ -141,13 +144,13 @@ Running this script will generate the header image at the specified output path.
|
|
141 |
See the "Usage" section above.
|
142 |
|
143 |
|
144 |
-
## ๐ What's New
|
145 |
|
146 |
-
-
|
147 |
-
-
|
148 |
-
-
|
149 |
-
-
|
150 |
-
-
|
151 |
|
152 |
|
153 |
## ๐ License
|
|
|
1 |
---
|
2 |
license: mit
|
3 |
+
title: Pic-to-Header
|
4 |
sdk: streamlit
|
5 |
emoji: ๐จ
|
6 |
colorFrom: blue
|
|
|
28 |
|
29 |
</div>
|
30 |
|
31 |
+
Pic-to-Header is a Python application that generates header images using a mask image and an input image. Version 0.2.0 has been released.
|
32 |
|
33 |
## ๐ Project Overview
|
34 |
|
35 |
+
Pic-to-Header is a Streamlit application that allows you to easily generate and download header images using a mask image and an input image. It's also available on PyPI. It also supports a command-line interface (CLI).
|
36 |
|
37 |
|
38 |
## ๐ฅ Demo Video
|
|
|
42 |
|
43 |
## ๐ค Demo Site
|
44 |
|
45 |
+
<!-- Spaces status badge -->
|
46 |
[![Spaces](https://img.shields.io/badge/๐ค%20Hugging%20Face-Spaces-yellow.svg)](https://huggingface.co/spaces/MakiAi/pic-to-header)
|
47 |
|
48 |
## โจ Key Features
|
|
|
51 |
- Generate header images
|
52 |
- Preview and download generated header images
|
53 |
- Image processing using a command-line interface (CLI)
|
54 |
+
- Mask management features
|
55 |
+
- Extended image processing logic
|
56 |
+
- Image processing functionality via Python script
|
57 |
+
- Addition of README page and release notes page to the Streamlit app
|
58 |
|
59 |
|
60 |
## ๐ง Usage
|
|
|
81 |
|
82 |
### Streamlit Web Application
|
83 |
|
84 |
+
1. Start the Streamlit application:
|
85 |
```bash
|
86 |
streamlit run pic_to_header/app.py
|
87 |
```
|
88 |
2. Access the URL displayed in your browser.
|
89 |
+
3. Upload the input image and mask image.
|
90 |
4. Click the "Generate Header Image" button.
|
91 |
+
5. Preview the generated header image and download it if necessary.
|
92 |
|
93 |
|
94 |
### Command-Line Interface (CLI)
|
|
|
105 |
pic-to-header assets/sample.png assets/mask.png output_image.png
|
106 |
```
|
107 |
|
108 |
+
### Using a Python Script
|
109 |
|
110 |
+
The `pic_to_header` package can also be used directly within Python scripts. Here is an example:
|
111 |
|
112 |
```python
|
113 |
from pic_to_header.core import process_header_image
|
|
|
134 |
|
135 |
## ๐ป Development
|
136 |
|
137 |
+
- `pic_to_header/core.py`: Contains the main image processing functionality.
|
138 |
- `pic_to_header/app.py`: Provides the web interface using Streamlit.
|
139 |
- `pic_to_header/cli.py`: Provides the command-line interface.
|
140 |
|
|
|
144 |
See the "Usage" section above.
|
145 |
|
146 |
|
147 |
+
## ๐ What's New (v0.2.0)
|
148 |
|
149 |
+
- **Mask Management Feature Implementation:** Mask images can now be obtained from presets, URLs, and uploaded files. A preset mask management feature has also been added.
|
150 |
+
- **Extended Image Processing Logic:** Automatic adjustment of the number of channels for images and mask images, mask image resizing, mask transparency adjustment, and the ability to return processing results as PIL Images have been added.
|
151 |
+
- **Added Python Script Image Processing Functionality and Updated Documentation:** The usage of the `process_header_image` function is explained step-by-step.
|
152 |
+
- **UI Improvements:** Streamlit wide mode setting, addition of mask image acquisition methods (presets, URL, upload), mask transparency adjustment slider, support for multiple image uploads, changes to the display method of processing results, addition of a download button, and enhanced error handling have been implemented.
|
153 |
+
- **Added links to Hugging Face Spaces demo site and demo video.**
|
154 |
|
155 |
|
156 |
## ๐ License
|