-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(diffusers): supplement the docs of diffusers on gitHub page
- Loading branch information
1 parent
65dadea
commit 25d9de0
Showing
101 changed files
with
12,579 additions
and
578 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| <!--Copyright 2024 The HuggingFace Team. All rights reserved. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with | ||
| the License. You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on | ||
| an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations under the License. | ||
| --> | ||
|
|
||
| # Configuration | ||
|
|
||
| Schedulers from [`SchedulerMixin`](https://mindspore-lab.github.io/mindone/latest/diffusers/api/schedulers/overview/#mindone.diffusers.SchedulerMixin) and models from [`ModelMixin`](https://mindspore-lab.github.io/mindone/latest/diffusers/api/models/overview/#mindone.diffusers.ModelMixin) inherit from [`ConfigMixin`](https://mindspore-lab.github.io/mindone/latest/diffusers/api/configuration/#mindone.diffusers.configuration_utils.ConfigMixin) which stores all the parameters that are passed to their respective `__init__` methods in a JSON-configuration file. | ||
|
|
||
| !!! tip | ||
|
|
||
| To use private or [gated](https://huggingface.co/docs/hub/models-gated#gated-models) models, log-in with `huggingface-cli login`. | ||
|
|
||
| ::: mindone.diffusers.configuration_utils.ConfigMixin | ||
| options: | ||
| members: | ||
| - load_config | ||
| - from_config | ||
| - save_config | ||
| - to_json_file | ||
| - to_json_string |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| <!--Copyright 2024 The HuggingFace Team. All rights reserved. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with | ||
| the License. You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on | ||
| an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations under the License. | ||
| --> | ||
|
|
||
| # Logging | ||
|
|
||
| 🤗 Diffusers has a centralized logging system to easily manage the verbosity of the library. The default verbosity is set to `WARNING`. | ||
|
|
||
| To change the verbosity level, use one of the direct setters. For instance, to change the verbosity to the `INFO` level. | ||
|
|
||
| ```python | ||
| import mindone.diffusers | ||
|
|
||
| mindone.diffusers.logging.set_verbosity_info() | ||
| ``` | ||
|
|
||
| You can also use the environment variable `DIFFUSERS_VERBOSITY` to override the default verbosity. You can set it | ||
| to one of the following: `debug`, `info`, `warning`, `error`, `critical`. For example: | ||
|
|
||
| ```bash | ||
| DIFFUSERS_VERBOSITY=error ./myprogram.py | ||
| ``` | ||
|
|
||
| Additionally, some `warnings` can be disabled by setting the environment variable | ||
| `DIFFUSERS_NO_ADVISORY_WARNINGS` to a true value, like `1`. This disables any warning logged by | ||
| [`logger.warning_advice`]. For example: | ||
|
|
||
| ```bash | ||
| DIFFUSERS_NO_ADVISORY_WARNINGS=1 ./myprogram.py | ||
| ``` | ||
|
|
||
| Here is an example of how to use the same logger as the library in your own module or script: | ||
|
|
||
| ```python | ||
| from mindone.diffusers.utils import logging | ||
|
|
||
| logging.set_verbosity_info() | ||
| logger = logging.get_logger("diffusers") | ||
| logger.info("INFO") | ||
| logger.warning("WARN") | ||
| ``` | ||
|
|
||
| All methods of the logging module are documented below. The main methods are | ||
| [`get_verbosity`](https://mindspore-lab.github.io/mindone/latest/diffusers/api/logging/#mindone.diffusers.utils.logging.get_verbosity) to get the current level of verbosity in the logger and | ||
| [`set_verbosity`](https://mindspore-lab.github.io/mindone/latest/diffusers/api/logging/#mindone.diffusers.utils.logging.set_verbosity) to set the verbosity to the level of your choice. | ||
|
|
||
| In order from the least verbose to the most verbose: | ||
|
|
||
| | Method | Integer value | Description | | ||
| |----------------------------------------------------------:|--------------:|----------------------------------------------------:| | ||
| | `diffusers.logging.CRITICAL` or `diffusers.logging.FATAL` | 50 | only report the most critical errors | | ||
| | `diffusers.logging.ERROR` | 40 | only report errors | | ||
| | `diffusers.logging.WARNING` or `diffusers.logging.WARN` | 30 | only report errors and warnings (default) | | ||
| | `diffusers.logging.INFO` | 20 | only report errors, warnings, and basic information | | ||
| | `diffusers.logging.DEBUG` | 10 | report all information | | ||
|
|
||
| By default, `tqdm` progress bars are displayed during model download. [`disable_progress_bar`](https://mindspore-lab.github.io/mindone/latest/diffusers/api/logging/#mindone.diffusers.utils.logging.disable_progress_bar) and [`enable_progress_bar`](https://mindspore-lab.github.io/mindone/latest/diffusers/api/logging/#mindone.diffusers.utils.logging.enable_progress_bar) are used to enable or disable this behavior. | ||
|
|
||
| ## Base setters | ||
|
|
||
| ::: mindone.diffusers.utils.logging.set_verbosity_error | ||
| options: | ||
| heading_level: 3 | ||
|
|
||
| ::: mindone.diffusers.utils.logging.set_verbosity_warning | ||
| options: | ||
| heading_level: 3 | ||
|
|
||
| ::: mindone.diffusers.utils.logging.set_verbosity_info | ||
| options: | ||
| heading_level: 3 | ||
|
|
||
| ::: mindone.diffusers.utils.logging.set_verbosity_debug | ||
| options: | ||
| heading_level: 3 | ||
|
|
||
| ## Other functions | ||
|
|
||
| ::: mindone.diffusers.utils.logging.get_verbosity | ||
| options: | ||
| heading_level: 3 | ||
|
|
||
| ::: mindone.diffusers.utils.logging.set_verbosity | ||
| options: | ||
| heading_level: 3 | ||
|
|
||
| ::: mindone.diffusers.utils.logging.get_logger | ||
| options: | ||
| heading_level: 3 | ||
|
|
||
| ::: mindone.diffusers.utils.logging.enable_default_handler | ||
| options: | ||
| heading_level: 3 | ||
|
|
||
| ::: mindone.diffusers.utils.logging.disable_default_handler | ||
| options: | ||
| heading_level: 3 | ||
|
|
||
| ::: mindone.diffusers.utils.logging.enable_explicit_format | ||
| options: | ||
| heading_level: 3 | ||
|
|
||
| ::: mindone.diffusers.utils.logging.reset_format | ||
| options: | ||
| heading_level: 3 | ||
|
|
||
| ::: mindone.diffusers.utils.logging.enable_progress_bar | ||
| options: | ||
| heading_level: 3 | ||
|
|
||
| ::: mindone.diffusers.utils.logging.disable_progress_bar | ||
| options: | ||
| heading_level: 3 |
Oops, something went wrong.