mirror of
https://github.com/iperov/DeepFaceLab.git
synced 2025-08-22 14:24:40 -07:00
Adds changelog and web ui docs
This commit is contained in:
parent
424b38d2c0
commit
9db45712fd
3 changed files with 72 additions and 0 deletions
27
CHANGELOG.md
Normal file
27
CHANGELOG.md
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
# Changelog
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [Unreleased]
|
||||||
|
n/a
|
||||||
|
|
||||||
|
## [1.1.1] - 2020-03-12
|
||||||
|
### Added
|
||||||
|
- CHANGELOG file for tracking updates, new features, and bug fixes
|
||||||
|
- Documentation for Web UI
|
||||||
|
|
||||||
|
## [1.1.0] - 2020-03-11
|
||||||
|
### Added
|
||||||
|
- [Web UI for training preview](doc/features/webui/README.md)
|
||||||
|
|
||||||
|
## [1.0.0] - 2021-03-09
|
||||||
|
### Initialized
|
||||||
|
- Reset stale master branch to [seranus/DeepFaceLab](https://github.com/seranus/DeepFaceLab),
|
||||||
|
21 commits ahead of [iperov/DeepFaceLab](https://github.com/iperov/DeepFaceLab) ([compare](https://github.com/iperov/DeepFaceLab/compare/4818183...seranus:3f5ae05))
|
||||||
|
|
||||||
|
[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.1.0...HEAD
|
||||||
|
[1.1.1]: https://github.com/faceshiftlabs/DeepFaceLab/compare/v1.1.0...v1.1.1
|
||||||
|
[1.1.0]: https://github.com/faceshiftlabs/DeepFaceLab/compare/v1.0.0...v1.1.0
|
||||||
|
[1.0.0]: https://github.com/faceshiftlabs/DeepFaceLab/releases/tag/v1.0.0
|
45
doc/features/webui/README.md
Normal file
45
doc/features/webui/README.md
Normal file
|
@ -0,0 +1,45 @@
|
||||||
|
# Web UI
|
||||||
|
|
||||||
|
View and interact with the training preview window with your web browser.
|
||||||
|
Allows you to view and control the preview remotely, and train on headless machines.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
- [INSTALLATION](#installation)
|
||||||
|
- [DESCRIPTION](#description)
|
||||||
|
- [USAGE](#usage)
|
||||||
|
- [SSH PORT FORWARDING](#ssh-port-forwarding)
|
||||||
|
|
||||||
|
## INSTALLATION
|
||||||
|
|
||||||
|
Requires additional Python dependencies to be installed:
|
||||||
|
- [Flask](https://palletsprojects.com/p/flask/),
|
||||||
|
version [1.1.1](https://pypi.org/project/Flask/1.1.1/)
|
||||||
|
- [Flask-SocketIO](https://github.com/miguelgrinberg/Flask-SocketIO/),
|
||||||
|
version [4.2.1](https://pypi.org/project/Flask-SocketIO/4.2.1/)
|
||||||
|
|
||||||
|
```
|
||||||
|
pip install Flask==1.1.1
|
||||||
|
pip install Flask-SocketIO==4.2.1
|
||||||
|
```
|
||||||
|
|
||||||
|
## DESCRIPTION
|
||||||
|
|
||||||
|
Launches a Flask web application which sends commands to the training thread
|
||||||
|
(save/exit/fetch new preview, etc.), and displays live updates for the log output
|
||||||
|
e.g.: `[09:50:53][#106913][0503ms][0.3109][0.2476]`, and updates the graph/preview image.
|
||||||
|
|
||||||
|
## USAGE
|
||||||
|
|
||||||
|
Enable the Web UI by appending `--flask-preview` to the `train` command.
|
||||||
|
Once training begins, Web UI will start, and can be accessed at http://localhost:5000/
|
||||||
|
|
||||||
|
## SSH PORT FORWARDING
|
||||||
|
|
||||||
|
When running on a remote/headless box, view the Web UI in your local browser simply by
|
||||||
|
adding the ssh option `-L 5000:localhost:5000`. Once connected, the Web UI can be viewed
|
||||||
|
locally at http://localhost:5000/
|
||||||
|
|
||||||
|
Several Android/iOS SSH apps (such as [JuiceSSH](https://juicessh.com/)
|
||||||
|
exist which support port forwarding, allowing you to interact with the preview pane
|
||||||
|
from anywhere with your phone.
|
BIN
doc/features/webui/example.png
Normal file
BIN
doc/features/webui/example.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.1 MiB |
Loading…
Add table
Add a link
Reference in a new issue