Add files using upload-large-folder tool
Browse filesThis view is limited to 50 files because it contains too many changes. See raw diff
- .cache/pip/http-v2/0/2/c/c/0/02cc041a5121df0569936bde1aff1c8f8429b05c530960dda806c32a +0 -0
- .cache/pip/http-v2/0/2/c/c/0/02cc041a5121df0569936bde1aff1c8f8429b05c530960dda806c32a.body +329 -0
- .cache/pip/http-v2/0/2/f/7/a/02f7a3cfa8e6aa881ea9780e7473e44a5ee78388ef2ddf2bbdaf9c4c +0 -0
- .cache/pip/http-v2/0/2/f/7/a/02f7a3cfa8e6aa881ea9780e7473e44a5ee78388ef2ddf2bbdaf9c4c.body +88 -0
- .cache/pip/http-v2/0/4/4/7/c/0447ce2249fdae0f8cf52a43e01f215eacdf7c35d89a248bd4b4ebaa +0 -0
- .cache/pip/http-v2/0/4/4/7/c/0447ce2249fdae0f8cf52a43e01f215eacdf7c35d89a248bd4b4ebaa.body +0 -0
- .cache/pip/http-v2/2/6/9/6/f/2696f961349c363ba6eaa61f1f16df2705938f26ba64023adb039e90 +0 -0
- .cache/pip/http-v2/2/6/9/6/f/2696f961349c363ba6eaa61f1f16df2705938f26ba64023adb039e90.body +0 -0
- .cache/pip/http-v2/2/7/7/6/0/2776091d74378df9859068b389c0d96d3f76c8668c74613451e22e86 +0 -0
- .cache/pip/http-v2/2/9/5/4/2/2954216e93dc816d61408bd6f0b67c741271fd7cfbf7e39bfb692beb +0 -0
- .cache/pip/http-v2/2/9/5/4/2/2954216e93dc816d61408bd6f0b67c741271fd7cfbf7e39bfb692beb.body +581 -0
- .cache/pip/http-v2/2/b/d/2/a/2bd2afb46be8ef29cc0dd505de4aff907384c53895a0fbbce798558e +0 -0
- .cache/pip/http-v2/2/b/d/2/a/2bd2afb46be8ef29cc0dd505de4aff907384c53895a0fbbce798558e.body +354 -0
- .cache/pip/http-v2/3/3/2/7/a/3327a46f678846be6cb46f3352e6fba668d9664c70a79484c770e358 +0 -0
- .cache/pip/http-v2/3/4/a/c/e/34ace27b9fbcfbe3592fe5b9ea07a848064781b37e129803e4325770 +0 -0
- .cache/pip/http-v2/3/4/a/c/e/34ace27b9fbcfbe3592fe5b9ea07a848064781b37e129803e4325770.body +1600 -0
- .cache/pip/http-v2/3/5/a/0/6/35a0615e0411edd59492c90e8f5cd0a1a0554d6f7d1dec5be2b30560 +0 -0
- .cache/pip/http-v2/3/8/9/2/7/389270eb64d5d655add63491064e7e833611004a96c2fb8b19caa5fb.body +321 -0
- .cache/pip/http-v2/4/5/2/4/1/45241d61b1606b84c3825a9119b750e7cd16e5fac504d31f79203a8e +0 -0
- .cache/pip/http-v2/4/5/2/4/1/45241d61b1606b84c3825a9119b750e7cd16e5fac504d31f79203a8e.body +84 -0
- .cache/pip/http-v2/4/a/5/b/6/4a5b6f0d76201de4cfd4884f5e95617a1848cf81c8357be4d12cbf6a +0 -0
- .cache/pip/http-v2/4/a/5/b/6/4a5b6f0d76201de4cfd4884f5e95617a1848cf81c8357be4d12cbf6a.body +86 -0
- .cache/pip/http-v2/4/d/c/8/d/4dc8d567db4bc55c0684404c85a6b4572f87a99306be24cab65fbfae +0 -0
- .cache/pip/http-v2/4/d/c/8/d/4dc8d567db4bc55c0684404c85a6b4572f87a99306be24cab65fbfae.body +0 -0
- .cache/pip/http-v2/5/9/1/a/0/591a0a7ea47d81cffb332bf5e1460e560ce743822558c6f345314d4b +0 -0
- .cache/pip/http-v2/5/9/1/a/0/591a0a7ea47d81cffb332bf5e1460e560ce743822558c6f345314d4b.body +0 -0
- .cache/pip/http-v2/5/e/c/8/b/5ec8b58bc827caa12672b72c08527dbd1c5456edeea815f1e76cb526 +0 -0
- .cache/pip/http-v2/6/4/c/f/c/64cfc03e83f9fad4049b1d2a1d785c9273270a4ab9788b538f5054e3 +0 -0
- .cache/pip/http-v2/6/5/1/e/5/651e58859e8db8c99b9e7068d03984cfd4577518ff0e021c717afbf4 +0 -0
- .cache/pip/http-v2/6/5/1/e/5/651e58859e8db8c99b9e7068d03984cfd4577518ff0e021c717afbf4.body +78 -0
- .cache/pip/http-v2/6/6/e/c/7/66ec76a7b6ed4081044f5c7821af293b63c17bc2ac523ff93d5ca7d5 +0 -0
- .cache/pip/http-v2/6/8/0/d/4/680d4dd80dc6a3d2df9b9478dfcc8e81e0e4f130e154a3268b98b877 +0 -0
- .cache/pip/http-v2/6/9/2/f/2/692f2804b6b8394551c77857160a003c2da933441522c71fd20e4ca4 +0 -0
- .cache/pip/http-v2/6/b/5/3/a/6b53a9dd0e4fce887cc28c1a921aa1befe8c1a82e6c213d2542d2acb +0 -0
- .cache/pip/http-v2/6/b/5/3/a/6b53a9dd0e4fce887cc28c1a921aa1befe8c1a82e6c213d2542d2acb.body +0 -0
- .cache/pip/http-v2/6/c/6/e/e/6c6eeaf6757edbde690577822daacaba826c2b12ce67b57b33e8021d +0 -0
- .cache/pip/http-v2/6/c/6/e/e/6c6eeaf6757edbde690577822daacaba826c2b12ce67b57b33e8021d.body +0 -0
- .cache/pip/http-v2/7/2/8/a/2/728a2f33f382f4dacf08f6df77aad6f3d889f819ba4fa3efad5ec7e4 +0 -0
- .cache/pip/http-v2/7/5/c/7/6/75c76ba3da983fc745a6549a0de110dcd624d42b682204260c21f535 +0 -0
- .cache/pip/http-v2/7/9/2/1/a/7921ac3318a5cdb592026cc26a94f7a2c1e1f7d3a1dc1e3857fd49f1 +0 -0
- .cache/pip/http-v2/7/9/2/1/a/7921ac3318a5cdb592026cc26a94f7a2c1e1f7d3a1dc1e3857fd49f1.body +0 -0
- .cache/pip/http-v2/7/f/0/e/c/7f0ec35e0c3a1faba9aada2b4b15e64482162fc43af0f7193ee83003 +0 -0
- .cache/pip/http-v2/8/1/8/8/f/8188f9db6169e57bb653240cc02c629488d0d899420b0725db0f7e4a +0 -0
- .cache/pip/http-v2/8/a/c/4/d/8ac4d14dc45e27d21da49fb515570b6f875b78707de9b08ce1088d1b +0 -0
- .cache/pip/http-v2/8/a/c/4/d/8ac4d14dc45e27d21da49fb515570b6f875b78707de9b08ce1088d1b.body +0 -0
- .cache/pip/http-v2/8/e/0/9/f/8e09f241e363fdfdfd9cade803fe7df10d489fd9430647a4b0b3c719 +0 -0
- .cache/pip/http-v2/8/e/0/9/f/8e09f241e363fdfdfd9cade803fe7df10d489fd9430647a4b0b3c719.body +1383 -0
- .cache/pip/http-v2/8/f/0/a/d/8f0ad583652318494c12da41e4d30ff6225ec73d448a0754a0a7e898 +0 -0
- .cache/pip/http-v2/9/0/6/7/9/906797ab7b3f56fdd856b186be66ce1ad5fb99862a404c1091a707b6 +0 -0
- .cache/pip/http-v2/9/0/6/7/9/906797ab7b3f56fdd856b186be66ce1ad5fb99862a404c1091a707b6.body +0 -0
.cache/pip/http-v2/0/2/c/c/0/02cc041a5121df0569936bde1aff1c8f8429b05c530960dda806c32a
ADDED
|
Binary file (1.28 kB). View file
|
|
|
.cache/pip/http-v2/0/2/c/c/0/02cc041a5121df0569936bde1aff1c8f8429b05c530960dda806c32a.body
ADDED
|
@@ -0,0 +1,329 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Metadata-Version: 2.4
|
| 2 |
+
Name: huggingface_hub
|
| 3 |
+
Version: 1.22.0
|
| 4 |
+
Summary: Client library to download and publish models, datasets and other repos on the huggingface.co hub
|
| 5 |
+
Home-page: https://github.com/huggingface/huggingface_hub
|
| 6 |
+
Author: Hugging Face, Inc.
|
| 7 |
+
Author-email: julien@huggingface.co
|
| 8 |
+
License: Apache-2.0
|
| 9 |
+
Keywords: model-hub machine-learning models natural-language-processing deep-learning pytorch pretrained-models
|
| 10 |
+
Classifier: Intended Audience :: Developers
|
| 11 |
+
Classifier: Intended Audience :: Education
|
| 12 |
+
Classifier: Intended Audience :: Science/Research
|
| 13 |
+
Classifier: License :: OSI Approved :: Apache Software License
|
| 14 |
+
Classifier: Operating System :: OS Independent
|
| 15 |
+
Classifier: Programming Language :: Python :: 3
|
| 16 |
+
Classifier: Programming Language :: Python :: 3 :: Only
|
| 17 |
+
Classifier: Programming Language :: Python :: 3.10
|
| 18 |
+
Classifier: Programming Language :: Python :: 3.11
|
| 19 |
+
Classifier: Programming Language :: Python :: 3.12
|
| 20 |
+
Classifier: Programming Language :: Python :: 3.13
|
| 21 |
+
Classifier: Programming Language :: Python :: 3.14
|
| 22 |
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
| 23 |
+
Requires-Python: >=3.10.0
|
| 24 |
+
Description-Content-Type: text/markdown
|
| 25 |
+
License-File: LICENSE
|
| 26 |
+
Requires-Dist: click<9.0.0,>=8.4.2
|
| 27 |
+
Requires-Dist: filelock>=3.10.0
|
| 28 |
+
Requires-Dist: fsspec>=2023.5.0
|
| 29 |
+
Requires-Dist: hf-xet<2.0.0,>=1.5.1; platform_machine == "x86_64" or platform_machine == "amd64" or platform_machine == "AMD64" or platform_machine == "arm64" or platform_machine == "aarch64"
|
| 30 |
+
Requires-Dist: httpx<1,>=0.23.0
|
| 31 |
+
Requires-Dist: packaging>=20.9
|
| 32 |
+
Requires-Dist: pyyaml>=5.1
|
| 33 |
+
Requires-Dist: tqdm>=4.42.1
|
| 34 |
+
Requires-Dist: typing-extensions>=4.1.0
|
| 35 |
+
Provides-Extra: oauth
|
| 36 |
+
Requires-Dist: authlib>=1.3.2; extra == "oauth"
|
| 37 |
+
Requires-Dist: fastapi; extra == "oauth"
|
| 38 |
+
Requires-Dist: httpx; extra == "oauth"
|
| 39 |
+
Requires-Dist: itsdangerous; extra == "oauth"
|
| 40 |
+
Provides-Extra: torch
|
| 41 |
+
Requires-Dist: torch; extra == "torch"
|
| 42 |
+
Requires-Dist: safetensors[torch]; extra == "torch"
|
| 43 |
+
Provides-Extra: fastai
|
| 44 |
+
Requires-Dist: toml; extra == "fastai"
|
| 45 |
+
Requires-Dist: fastai>=2.4; extra == "fastai"
|
| 46 |
+
Requires-Dist: fastcore>=1.3.27; extra == "fastai"
|
| 47 |
+
Provides-Extra: hf-xet
|
| 48 |
+
Requires-Dist: hf-xet<2.0.0,>=1.5.1; extra == "hf-xet"
|
| 49 |
+
Provides-Extra: mcp
|
| 50 |
+
Requires-Dist: mcp>=1.8.0; extra == "mcp"
|
| 51 |
+
Provides-Extra: testing
|
| 52 |
+
Requires-Dist: authlib>=1.3.2; extra == "testing"
|
| 53 |
+
Requires-Dist: fastapi; extra == "testing"
|
| 54 |
+
Requires-Dist: httpx; extra == "testing"
|
| 55 |
+
Requires-Dist: itsdangerous; extra == "testing"
|
| 56 |
+
Requires-Dist: jedi; extra == "testing"
|
| 57 |
+
Requires-Dist: Jinja2; extra == "testing"
|
| 58 |
+
Requires-Dist: pytest>=8.4.2; extra == "testing"
|
| 59 |
+
Requires-Dist: pytest-cov; extra == "testing"
|
| 60 |
+
Requires-Dist: pytest-env; extra == "testing"
|
| 61 |
+
Requires-Dist: pytest-xdist; extra == "testing"
|
| 62 |
+
Requires-Dist: pytest-vcr; extra == "testing"
|
| 63 |
+
Requires-Dist: pytest-asyncio; extra == "testing"
|
| 64 |
+
Requires-Dist: pytest-rerunfailures<16.0; extra == "testing"
|
| 65 |
+
Requires-Dist: pytest-mock; extra == "testing"
|
| 66 |
+
Requires-Dist: urllib3<2.0; extra == "testing"
|
| 67 |
+
Requires-Dist: soundfile; extra == "testing"
|
| 68 |
+
Requires-Dist: Pillow; extra == "testing"
|
| 69 |
+
Requires-Dist: numpy; extra == "testing"
|
| 70 |
+
Requires-Dist: duckdb; extra == "testing"
|
| 71 |
+
Requires-Dist: fastapi; extra == "testing"
|
| 72 |
+
Provides-Extra: gradio
|
| 73 |
+
Requires-Dist: gradio>=5.0.0; extra == "gradio"
|
| 74 |
+
Requires-Dist: requests; extra == "gradio"
|
| 75 |
+
Provides-Extra: typing
|
| 76 |
+
Requires-Dist: typing-extensions>=4.8.0; extra == "typing"
|
| 77 |
+
Requires-Dist: types-PyYAML; extra == "typing"
|
| 78 |
+
Requires-Dist: types-simplejson; extra == "typing"
|
| 79 |
+
Requires-Dist: types-toml; extra == "typing"
|
| 80 |
+
Requires-Dist: types-tqdm; extra == "typing"
|
| 81 |
+
Requires-Dist: types-urllib3; extra == "typing"
|
| 82 |
+
Provides-Extra: quality
|
| 83 |
+
Requires-Dist: ruff>=0.9.0; extra == "quality"
|
| 84 |
+
Requires-Dist: mypy==1.15.0; extra == "quality"
|
| 85 |
+
Requires-Dist: libcst>=1.4.0; extra == "quality"
|
| 86 |
+
Requires-Dist: ty; extra == "quality"
|
| 87 |
+
Provides-Extra: all
|
| 88 |
+
Requires-Dist: authlib>=1.3.2; extra == "all"
|
| 89 |
+
Requires-Dist: fastapi; extra == "all"
|
| 90 |
+
Requires-Dist: httpx; extra == "all"
|
| 91 |
+
Requires-Dist: itsdangerous; extra == "all"
|
| 92 |
+
Requires-Dist: jedi; extra == "all"
|
| 93 |
+
Requires-Dist: Jinja2; extra == "all"
|
| 94 |
+
Requires-Dist: pytest>=8.4.2; extra == "all"
|
| 95 |
+
Requires-Dist: pytest-cov; extra == "all"
|
| 96 |
+
Requires-Dist: pytest-env; extra == "all"
|
| 97 |
+
Requires-Dist: pytest-xdist; extra == "all"
|
| 98 |
+
Requires-Dist: pytest-vcr; extra == "all"
|
| 99 |
+
Requires-Dist: pytest-asyncio; extra == "all"
|
| 100 |
+
Requires-Dist: pytest-rerunfailures<16.0; extra == "all"
|
| 101 |
+
Requires-Dist: pytest-mock; extra == "all"
|
| 102 |
+
Requires-Dist: urllib3<2.0; extra == "all"
|
| 103 |
+
Requires-Dist: soundfile; extra == "all"
|
| 104 |
+
Requires-Dist: Pillow; extra == "all"
|
| 105 |
+
Requires-Dist: numpy; extra == "all"
|
| 106 |
+
Requires-Dist: duckdb; extra == "all"
|
| 107 |
+
Requires-Dist: fastapi; extra == "all"
|
| 108 |
+
Requires-Dist: ruff>=0.9.0; extra == "all"
|
| 109 |
+
Requires-Dist: mypy==1.15.0; extra == "all"
|
| 110 |
+
Requires-Dist: libcst>=1.4.0; extra == "all"
|
| 111 |
+
Requires-Dist: ty; extra == "all"
|
| 112 |
+
Requires-Dist: typing-extensions>=4.8.0; extra == "all"
|
| 113 |
+
Requires-Dist: types-PyYAML; extra == "all"
|
| 114 |
+
Requires-Dist: types-simplejson; extra == "all"
|
| 115 |
+
Requires-Dist: types-toml; extra == "all"
|
| 116 |
+
Requires-Dist: types-tqdm; extra == "all"
|
| 117 |
+
Requires-Dist: types-urllib3; extra == "all"
|
| 118 |
+
Provides-Extra: dev
|
| 119 |
+
Requires-Dist: authlib>=1.3.2; extra == "dev"
|
| 120 |
+
Requires-Dist: fastapi; extra == "dev"
|
| 121 |
+
Requires-Dist: httpx; extra == "dev"
|
| 122 |
+
Requires-Dist: itsdangerous; extra == "dev"
|
| 123 |
+
Requires-Dist: jedi; extra == "dev"
|
| 124 |
+
Requires-Dist: Jinja2; extra == "dev"
|
| 125 |
+
Requires-Dist: pytest>=8.4.2; extra == "dev"
|
| 126 |
+
Requires-Dist: pytest-cov; extra == "dev"
|
| 127 |
+
Requires-Dist: pytest-env; extra == "dev"
|
| 128 |
+
Requires-Dist: pytest-xdist; extra == "dev"
|
| 129 |
+
Requires-Dist: pytest-vcr; extra == "dev"
|
| 130 |
+
Requires-Dist: pytest-asyncio; extra == "dev"
|
| 131 |
+
Requires-Dist: pytest-rerunfailures<16.0; extra == "dev"
|
| 132 |
+
Requires-Dist: pytest-mock; extra == "dev"
|
| 133 |
+
Requires-Dist: urllib3<2.0; extra == "dev"
|
| 134 |
+
Requires-Dist: soundfile; extra == "dev"
|
| 135 |
+
Requires-Dist: Pillow; extra == "dev"
|
| 136 |
+
Requires-Dist: numpy; extra == "dev"
|
| 137 |
+
Requires-Dist: duckdb; extra == "dev"
|
| 138 |
+
Requires-Dist: fastapi; extra == "dev"
|
| 139 |
+
Requires-Dist: ruff>=0.9.0; extra == "dev"
|
| 140 |
+
Requires-Dist: mypy==1.15.0; extra == "dev"
|
| 141 |
+
Requires-Dist: libcst>=1.4.0; extra == "dev"
|
| 142 |
+
Requires-Dist: ty; extra == "dev"
|
| 143 |
+
Requires-Dist: typing-extensions>=4.8.0; extra == "dev"
|
| 144 |
+
Requires-Dist: types-PyYAML; extra == "dev"
|
| 145 |
+
Requires-Dist: types-simplejson; extra == "dev"
|
| 146 |
+
Requires-Dist: types-toml; extra == "dev"
|
| 147 |
+
Requires-Dist: types-tqdm; extra == "dev"
|
| 148 |
+
Requires-Dist: types-urllib3; extra == "dev"
|
| 149 |
+
Dynamic: author
|
| 150 |
+
Dynamic: author-email
|
| 151 |
+
Dynamic: classifier
|
| 152 |
+
Dynamic: description
|
| 153 |
+
Dynamic: description-content-type
|
| 154 |
+
Dynamic: home-page
|
| 155 |
+
Dynamic: keywords
|
| 156 |
+
Dynamic: license
|
| 157 |
+
Dynamic: license-file
|
| 158 |
+
Dynamic: provides-extra
|
| 159 |
+
Dynamic: requires-dist
|
| 160 |
+
Dynamic: requires-python
|
| 161 |
+
Dynamic: summary
|
| 162 |
+
|
| 163 |
+
<p align="center">
|
| 164 |
+
<picture>
|
| 165 |
+
<source media="(prefers-color-scheme: dark)" srcset="https://huggingface.co/datasets/huggingface/documentation-images/raw/main/huggingface_hub-dark.svg">
|
| 166 |
+
<source media="(prefers-color-scheme: light)" srcset="https://huggingface.co/datasets/huggingface/documentation-images/raw/main/huggingface_hub.svg">
|
| 167 |
+
<img alt="huggingface_hub library logo" src="https://huggingface.co/datasets/huggingface/documentation-images/raw/main/huggingface_hub.svg" width="352" height="59" style="max-width: 100%">
|
| 168 |
+
</picture>
|
| 169 |
+
<br/>
|
| 170 |
+
<br/>
|
| 171 |
+
</p>
|
| 172 |
+
|
| 173 |
+
<p align="center">
|
| 174 |
+
<i>The official Python client for the Huggingface Hub.</i>
|
| 175 |
+
</p>
|
| 176 |
+
|
| 177 |
+
<p align="center">
|
| 178 |
+
<a href="https://huggingface.co/docs/huggingface_hub/en/index"><img alt="Documentation" src="https://img.shields.io/website/http/huggingface.co/docs/huggingface_hub/index.svg?down_color=red&down_message=offline&up_message=online&label=doc"></a>
|
| 179 |
+
<a href="https://github.com/huggingface/huggingface_hub/releases"><img alt="GitHub release" src="https://img.shields.io/github/release/huggingface/huggingface_hub.svg"></a>
|
| 180 |
+
<a href="https://github.com/huggingface/huggingface_hub"><img alt="PyPi version" src="https://img.shields.io/pypi/pyversions/huggingface_hub.svg"></a>
|
| 181 |
+
<a href="https://pypi.org/project/huggingface-hub"><img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/huggingface_hub"></a>
|
| 182 |
+
<a href="https://codecov.io/gh/huggingface/huggingface_hub"><img alt="Code coverage" src="https://codecov.io/gh/huggingface/huggingface_hub/branch/main/graph/badge.svg?token=RXP95LE2XL"></a>
|
| 183 |
+
</p>
|
| 184 |
+
|
| 185 |
+
<h4 align="center">
|
| 186 |
+
<p>
|
| 187 |
+
<b>English</b> |
|
| 188 |
+
<a href="https://github.com/huggingface/huggingface_hub/blob/main/i18n/README_de.md">Deutsch</a> |
|
| 189 |
+
<a href="https://github.com/huggingface/huggingface_hub/blob/main/i18n/README_fr.md">Français</a> |
|
| 190 |
+
<a href="https://github.com/huggingface/huggingface_hub/blob/main/i18n/README_hi.md">हिंदी</a> |
|
| 191 |
+
<a href="https://github.com/huggingface/huggingface_hub/blob/main/i18n/README_ko.md">한국어</a> |
|
| 192 |
+
<a href="https://github.com/huggingface/huggingface_hub/blob/main/i18n/README_cn.md">中文 (简体)</a>
|
| 193 |
+
<a href="https://github.com/huggingface/huggingface_hub/blob/main/i18n/README_kn.md">ಕನ್ನಡ</a>
|
| 194 |
+
<p>
|
| 195 |
+
</h4>
|
| 196 |
+
|
| 197 |
+
---
|
| 198 |
+
|
| 199 |
+
**Documentation**: <a href="https://hf.co/docs/huggingface_hub" target="_blank">https://hf.co/docs/huggingface_hub</a>
|
| 200 |
+
|
| 201 |
+
**Source Code**: <a href="https://github.com/huggingface/huggingface_hub" target="_blank">https://github.com/huggingface/huggingface_hub</a>
|
| 202 |
+
|
| 203 |
+
---
|
| 204 |
+
|
| 205 |
+
## Welcome to the huggingface_hub library
|
| 206 |
+
|
| 207 |
+
The `huggingface_hub` library allows you to interact with the [Hugging Face Hub](https://huggingface.co/), a platform democratizing open-source Machine Learning for creators and collaborators. Discover pre-trained models and datasets for your projects or play with the thousands of machine learning apps hosted on the Hub. You can also create and share your own models, datasets and demos with the community. The `huggingface_hub` library provides a simple way to do all these things with Python.
|
| 208 |
+
|
| 209 |
+
## Key features
|
| 210 |
+
|
| 211 |
+
- [Download files](https://huggingface.co/docs/huggingface_hub/en/guides/download) from the Hub.
|
| 212 |
+
- [Upload files](https://huggingface.co/docs/huggingface_hub/en/guides/upload) to the Hub.
|
| 213 |
+
- [Manage your repositories](https://huggingface.co/docs/huggingface_hub/en/guides/repository).
|
| 214 |
+
- [Run Inference](https://huggingface.co/docs/huggingface_hub/en/guides/inference) on deployed models.
|
| 215 |
+
- [Search](https://huggingface.co/docs/huggingface_hub/en/guides/search) for models, datasets and Spaces.
|
| 216 |
+
- [Share Model Cards](https://huggingface.co/docs/huggingface_hub/en/guides/model-cards) to document your models.
|
| 217 |
+
- [Engage with the community](https://huggingface.co/docs/huggingface_hub/en/guides/community) through PRs and comments.
|
| 218 |
+
|
| 219 |
+
## Installation
|
| 220 |
+
|
| 221 |
+
Install the `huggingface_hub` package with [pip](https://pypi.org/project/huggingface-hub/):
|
| 222 |
+
|
| 223 |
+
```bash
|
| 224 |
+
pip install huggingface_hub
|
| 225 |
+
```
|
| 226 |
+
|
| 227 |
+
We recommend using [`uv`](https://docs.astral.sh/uv/) for a fast and reliable install:
|
| 228 |
+
|
| 229 |
+
```bash
|
| 230 |
+
uv pip install huggingface_hub
|
| 231 |
+
```
|
| 232 |
+
|
| 233 |
+
In order to keep the package minimal by default, `huggingface_hub` comes with optional dependencies useful for some use cases. For example, if you want to use the MCP module, run:
|
| 234 |
+
|
| 235 |
+
```bash
|
| 236 |
+
pip install "huggingface_hub[mcp]"
|
| 237 |
+
```
|
| 238 |
+
|
| 239 |
+
To learn more about installation and optional dependencies, check out the [installation guide](https://huggingface.co/docs/huggingface_hub/en/installation).
|
| 240 |
+
|
| 241 |
+
## Quick start
|
| 242 |
+
|
| 243 |
+
### Download files
|
| 244 |
+
|
| 245 |
+
Download a single file
|
| 246 |
+
|
| 247 |
+
```py
|
| 248 |
+
from huggingface_hub import hf_hub_download
|
| 249 |
+
|
| 250 |
+
hf_hub_download(repo_id="tiiuae/falcon-7b-instruct", filename="config.json")
|
| 251 |
+
```
|
| 252 |
+
|
| 253 |
+
Or an entire repository
|
| 254 |
+
|
| 255 |
+
```py
|
| 256 |
+
from huggingface_hub import snapshot_download
|
| 257 |
+
|
| 258 |
+
snapshot_download("stabilityai/stable-diffusion-2-1")
|
| 259 |
+
```
|
| 260 |
+
|
| 261 |
+
Files will be downloaded in a local cache folder. More details in [this guide](https://huggingface.co/docs/huggingface_hub/en/guides/manage-cache).
|
| 262 |
+
|
| 263 |
+
### Login
|
| 264 |
+
|
| 265 |
+
The Hugging Face Hub uses tokens to authenticate applications (see [docs](https://huggingface.co/docs/hub/security-tokens)). To log in your machine, run the following CLI:
|
| 266 |
+
|
| 267 |
+
```bash
|
| 268 |
+
hf auth login
|
| 269 |
+
# or using an environment variable
|
| 270 |
+
hf auth login --token $HUGGINGFACE_TOKEN
|
| 271 |
+
```
|
| 272 |
+
|
| 273 |
+
### Create a repository
|
| 274 |
+
|
| 275 |
+
```py
|
| 276 |
+
from huggingface_hub import create_repo
|
| 277 |
+
|
| 278 |
+
create_repo(repo_id="super-cool-model")
|
| 279 |
+
```
|
| 280 |
+
|
| 281 |
+
### Upload files
|
| 282 |
+
|
| 283 |
+
Upload a single file
|
| 284 |
+
|
| 285 |
+
```py
|
| 286 |
+
from huggingface_hub import upload_file
|
| 287 |
+
|
| 288 |
+
upload_file(
|
| 289 |
+
path_or_fileobj="/home/lysandre/dummy-test/README.md",
|
| 290 |
+
path_in_repo="README.md",
|
| 291 |
+
repo_id="lysandre/test-model",
|
| 292 |
+
)
|
| 293 |
+
```
|
| 294 |
+
|
| 295 |
+
Or an entire folder
|
| 296 |
+
|
| 297 |
+
```py
|
| 298 |
+
from huggingface_hub import upload_folder
|
| 299 |
+
|
| 300 |
+
upload_folder(
|
| 301 |
+
folder_path="/path/to/local/space",
|
| 302 |
+
repo_id="username/my-cool-space",
|
| 303 |
+
repo_type="space",
|
| 304 |
+
)
|
| 305 |
+
```
|
| 306 |
+
|
| 307 |
+
For details in the [upload guide](https://huggingface.co/docs/huggingface_hub/en/guides/upload).
|
| 308 |
+
|
| 309 |
+
## Integrating to the Hub.
|
| 310 |
+
|
| 311 |
+
We're partnering with cool open source ML libraries to provide free model hosting and versioning. You can find the existing integrations [here](https://huggingface.co/docs/hub/libraries).
|
| 312 |
+
|
| 313 |
+
The advantages are:
|
| 314 |
+
|
| 315 |
+
- Free model or dataset hosting for libraries and their users.
|
| 316 |
+
- Built-in file versioning, even with very large files, thanks to a git-based approach.
|
| 317 |
+
- In-browser widgets to play with the uploaded models.
|
| 318 |
+
- Anyone can upload a new model for your library, they just need to add the corresponding tag for the model to be discoverable.
|
| 319 |
+
- Fast downloads! We use Cloudfront (a CDN) to geo-replicate downloads so they're blazing fast from anywhere on the globe.
|
| 320 |
+
- Usage stats and more features to come.
|
| 321 |
+
|
| 322 |
+
If you would like to integrate your library, feel free to open an issue to begin the discussion. We wrote a [step-by-step guide](https://huggingface.co/docs/hub/adding-a-library) with ❤️ showing how to do this integration.
|
| 323 |
+
|
| 324 |
+
## Contributions (feature requests, bugs, etc.) are super welcome 💙💚💛💜🧡❤️
|
| 325 |
+
|
| 326 |
+
Everyone is welcome to contribute, and we value everybody's contribution. Code is not the only way to help the community.
|
| 327 |
+
Answering questions, helping others, reaching out and improving the documentations are immensely valuable to the community.
|
| 328 |
+
We wrote a [contribution guide](https://github.com/huggingface/huggingface_hub/blob/main/CONTRIBUTING.md) to summarize
|
| 329 |
+
how to get started to contribute to this repository.
|
.cache/pip/http-v2/0/2/f/7/a/02f7a3cfa8e6aa881ea9780e7473e44a5ee78388ef2ddf2bbdaf9c4c
ADDED
|
Binary file (1.27 kB). View file
|
|
|
.cache/pip/http-v2/0/2/f/7/a/02f7a3cfa8e6aa881ea9780e7473e44a5ee78388ef2ddf2bbdaf9c4c.body
ADDED
|
@@ -0,0 +1,88 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Metadata-Version: 2.4
|
| 2 |
+
Name: Mako
|
| 3 |
+
Version: 1.3.12
|
| 4 |
+
Summary: A super-fast templating language that borrows the best ideas from the existing templating languages.
|
| 5 |
+
Home-page: https://www.makotemplates.org/
|
| 6 |
+
Author: Mike Bayer
|
| 7 |
+
Author-email: mike@zzzcomputing.com
|
| 8 |
+
License: MIT
|
| 9 |
+
Project-URL: Documentation, https://docs.makotemplates.org
|
| 10 |
+
Project-URL: Issue Tracker, https://github.com/sqlalchemy/mako
|
| 11 |
+
Classifier: Development Status :: 5 - Production/Stable
|
| 12 |
+
Classifier: License :: OSI Approved :: MIT License
|
| 13 |
+
Classifier: Environment :: Web Environment
|
| 14 |
+
Classifier: Intended Audience :: Developers
|
| 15 |
+
Classifier: Programming Language :: Python
|
| 16 |
+
Classifier: Programming Language :: Python :: 3
|
| 17 |
+
Classifier: Programming Language :: Python :: 3.8
|
| 18 |
+
Classifier: Programming Language :: Python :: 3.9
|
| 19 |
+
Classifier: Programming Language :: Python :: 3.10
|
| 20 |
+
Classifier: Programming Language :: Python :: 3.11
|
| 21 |
+
Classifier: Programming Language :: Python :: 3.12
|
| 22 |
+
Classifier: Programming Language :: Python :: Implementation :: CPython
|
| 23 |
+
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
| 24 |
+
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
|
| 25 |
+
Requires-Python: >=3.8
|
| 26 |
+
Description-Content-Type: text/x-rst
|
| 27 |
+
License-File: LICENSE
|
| 28 |
+
Requires-Dist: MarkupSafe>=0.9.2
|
| 29 |
+
Provides-Extra: testing
|
| 30 |
+
Requires-Dist: pytest; extra == "testing"
|
| 31 |
+
Provides-Extra: babel
|
| 32 |
+
Requires-Dist: Babel; extra == "babel"
|
| 33 |
+
Provides-Extra: lingua
|
| 34 |
+
Requires-Dist: lingua; extra == "lingua"
|
| 35 |
+
Dynamic: license-file
|
| 36 |
+
|
| 37 |
+
=========================
|
| 38 |
+
Mako Templates for Python
|
| 39 |
+
=========================
|
| 40 |
+
|
| 41 |
+
Mako is a template library written in Python. It provides a familiar, non-XML
|
| 42 |
+
syntax which compiles into Python modules for maximum performance. Mako's
|
| 43 |
+
syntax and API borrows from the best ideas of many others, including Django
|
| 44 |
+
templates, Cheetah, Myghty, and Genshi. Conceptually, Mako is an embedded
|
| 45 |
+
Python (i.e. Python Server Page) language, which refines the familiar ideas
|
| 46 |
+
of componentized layout and inheritance to produce one of the most
|
| 47 |
+
straightforward and flexible models available, while also maintaining close
|
| 48 |
+
ties to Python calling and scoping semantics.
|
| 49 |
+
|
| 50 |
+
Nutshell
|
| 51 |
+
========
|
| 52 |
+
|
| 53 |
+
::
|
| 54 |
+
|
| 55 |
+
<%inherit file="base.html"/>
|
| 56 |
+
<%
|
| 57 |
+
rows = [[v for v in range(0,10)] for row in range(0,10)]
|
| 58 |
+
%>
|
| 59 |
+
<table>
|
| 60 |
+
% for row in rows:
|
| 61 |
+
${makerow(row)}
|
| 62 |
+
% endfor
|
| 63 |
+
</table>
|
| 64 |
+
|
| 65 |
+
<%def name="makerow(row)">
|
| 66 |
+
<tr>
|
| 67 |
+
% for name in row:
|
| 68 |
+
<td>${name}</td>\
|
| 69 |
+
% endfor
|
| 70 |
+
</tr>
|
| 71 |
+
</%def>
|
| 72 |
+
|
| 73 |
+
Philosophy
|
| 74 |
+
===========
|
| 75 |
+
|
| 76 |
+
Python is a great scripting language. Don't reinvent the wheel...your templates can handle it !
|
| 77 |
+
|
| 78 |
+
Documentation
|
| 79 |
+
==============
|
| 80 |
+
|
| 81 |
+
See documentation for Mako at https://docs.makotemplates.org/en/latest/
|
| 82 |
+
|
| 83 |
+
License
|
| 84 |
+
========
|
| 85 |
+
|
| 86 |
+
Mako is licensed under an MIT-style license (see LICENSE).
|
| 87 |
+
Other incorporated projects may be licensed under different licenses.
|
| 88 |
+
All licenses allow for non-commercial and commercial use.
|
.cache/pip/http-v2/0/4/4/7/c/0447ce2249fdae0f8cf52a43e01f215eacdf7c35d89a248bd4b4ebaa
ADDED
|
Binary file (1.89 kB). View file
|
|
|
.cache/pip/http-v2/0/4/4/7/c/0447ce2249fdae0f8cf52a43e01f215eacdf7c35d89a248bd4b4ebaa.body
ADDED
|
Binary file (21 kB). View file
|
|
|
.cache/pip/http-v2/2/6/9/6/f/2696f961349c363ba6eaa61f1f16df2705938f26ba64023adb039e90
ADDED
|
Binary file (1.24 kB). View file
|
|
|
.cache/pip/http-v2/2/6/9/6/f/2696f961349c363ba6eaa61f1f16df2705938f26ba64023adb039e90.body
ADDED
|
Binary file (78.5 kB). View file
|
|
|
.cache/pip/http-v2/2/7/7/6/0/2776091d74378df9859068b389c0d96d3f76c8668c74613451e22e86
ADDED
|
Binary file (1.2 kB). View file
|
|
|
.cache/pip/http-v2/2/9/5/4/2/2954216e93dc816d61408bd6f0b67c741271fd7cfbf7e39bfb692beb
ADDED
|
Binary file (1.24 kB). View file
|
|
|
.cache/pip/http-v2/2/9/5/4/2/2954216e93dc816d61408bd6f0b67c741271fd7cfbf7e39bfb692beb.body
ADDED
|
@@ -0,0 +1,581 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Metadata-Version: 2.1
|
| 2 |
+
Name: timm
|
| 3 |
+
Version: 1.0.27
|
| 4 |
+
Summary: PyTorch Image Models
|
| 5 |
+
Keywords: pytorch,image-classification
|
| 6 |
+
Author-Email: Ross Wightman <ross@huggingface.co>
|
| 7 |
+
License: Apache-2.0
|
| 8 |
+
Classifier: Development Status :: 5 - Production/Stable
|
| 9 |
+
Classifier: Intended Audience :: Education
|
| 10 |
+
Classifier: Intended Audience :: Science/Research
|
| 11 |
+
Classifier: License :: OSI Approved :: Apache Software License
|
| 12 |
+
Classifier: Programming Language :: Python :: 3.8
|
| 13 |
+
Classifier: Programming Language :: Python :: 3.9
|
| 14 |
+
Classifier: Programming Language :: Python :: 3.10
|
| 15 |
+
Classifier: Programming Language :: Python :: 3.11
|
| 16 |
+
Classifier: Programming Language :: Python :: 3.12
|
| 17 |
+
Classifier: Topic :: Scientific/Engineering
|
| 18 |
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
| 19 |
+
Classifier: Topic :: Software Development
|
| 20 |
+
Classifier: Topic :: Software Development :: Libraries
|
| 21 |
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
| 22 |
+
Project-URL: homepage, https://github.com/huggingface/pytorch-image-models
|
| 23 |
+
Project-URL: documentation, https://huggingface.co/docs/timm/en/index
|
| 24 |
+
Project-URL: repository, https://github.com/huggingface/pytorch-image-models
|
| 25 |
+
Requires-Python: >=3.8
|
| 26 |
+
Requires-Dist: torch
|
| 27 |
+
Requires-Dist: torchvision
|
| 28 |
+
Requires-Dist: pyyaml
|
| 29 |
+
Requires-Dist: huggingface_hub
|
| 30 |
+
Requires-Dist: safetensors
|
| 31 |
+
Description-Content-Type: text/markdown
|
| 32 |
+
|
| 33 |
+
# PyTorch Image Models
|
| 34 |
+
- [What's New](#whats-new)
|
| 35 |
+
- [Introduction](#introduction)
|
| 36 |
+
- [Models](#models)
|
| 37 |
+
- [Features](#features)
|
| 38 |
+
- [Results](#results)
|
| 39 |
+
- [Getting Started (Documentation)](#getting-started-documentation)
|
| 40 |
+
- [Train, Validation, Inference Scripts](#train-validation-inference-scripts)
|
| 41 |
+
- [Awesome PyTorch Resources](#awesome-pytorch-resources)
|
| 42 |
+
- [Licenses](#licenses)
|
| 43 |
+
- [Citing](#citing)
|
| 44 |
+
|
| 45 |
+
## What's New
|
| 46 |
+
## May 8, 2026
|
| 47 |
+
* Release 1.0.27
|
| 48 |
+
|
| 49 |
+
## April 23, 2026
|
| 50 |
+
* Add Gemma4 ViT encoders w/ NaFlex pipeline support (variable aspect/size per image). Thanks [Yonghye Kwon](https://github.com/developer0hye)
|
| 51 |
+
* Support DINOv3 weights in NaFlexVit. Thanks [Yonghye Kwon](https://github.com/developer0hye)
|
| 52 |
+
* Some improvements to Muon fallback (AdamW/NadamW) lr behavior
|
| 53 |
+
|
| 54 |
+
## March 23, 2026
|
| 55 |
+
* Improve pickle checkpoint handling security. Default all loading to `weights_only=True`, add safe_global for ArgParse.
|
| 56 |
+
* Improve attention mask handling for core ViT/EVA models & layers. Resolve bool masks, pass `is_causal` through for SSL tasks.
|
| 57 |
+
* Fix class & register token uses with ViT and no pos embed enabled.
|
| 58 |
+
* Add Patch Representation Refinement (PRR) as a pooling option in ViT. Thanks Sina (https://github.com/sinahmr).
|
| 59 |
+
* Improve consistency of output projection / MLP dimensions for attention pooling layers.
|
| 60 |
+
* Hiera model F.SDPA optimization to allow Flash Attention kernel use.
|
| 61 |
+
* Caution added to SGDP optimizer.
|
| 62 |
+
* Release 1.0.26. First maintenance release since my departure from Hugging Face.
|
| 63 |
+
|
| 64 |
+
## Feb 23, 2026
|
| 65 |
+
* Add token distillation training support to distillation task wrappers
|
| 66 |
+
* Remove some torch.jit usage in prep for official deprecation
|
| 67 |
+
* Caution added to AdamP optimizer
|
| 68 |
+
* Call reset_parameters() even if meta-device init so that buffers get init w/ hacks like init_empty_weights
|
| 69 |
+
* Tweak Muon optimizer to work with DTensor/FSDP2 (clamp_ instead of clamp_min_, alternate NS branch for DTensor)
|
| 70 |
+
* Release 1.0.25
|
| 71 |
+
|
| 72 |
+
## Jan 21, 2026
|
| 73 |
+
* **Compat Break**: Fix oversight w/ QKV vs MLP bias in `ParallelScalingBlock` (& `DiffParallelScalingBlock`)
|
| 74 |
+
* Does not impact any trained `timm` models but could impact downstream use.
|
| 75 |
+
|
| 76 |
+
## Jan 5 & 6, 2026
|
| 77 |
+
* Release 1.0.24
|
| 78 |
+
* Add new benchmark result csv files for inference timing on all models w/ RTX Pro 6000, 5090, and 4090 cards w/ PyTorch 2.9.1
|
| 79 |
+
* Fix moved module error in deprecated timm.models.layers import path that impacts legacy imports
|
| 80 |
+
* Release 1.0.23
|
| 81 |
+
|
| 82 |
+
## Dec 30, 2025
|
| 83 |
+
* Add better NAdaMuon trained `dpwee`, `dwee`, `dlittle` (differential) ViTs with a small boost over previous runs
|
| 84 |
+
* https://huggingface.co/timm/vit_dlittle_patch16_reg1_gap_256.sbb_nadamuon_in1k (83.24% top-1)
|
| 85 |
+
* https://huggingface.co/timm/vit_dwee_patch16_reg1_gap_256.sbb_nadamuon_in1k (81.80% top-1)
|
| 86 |
+
* https://huggingface.co/timm/vit_dpwee_patch16_reg1_gap_256.sbb_nadamuon_in1k (81.67% top-1)
|
| 87 |
+
* Add a ~21M param `timm` variant of the CSATv2 model at 512x512 & 640x640
|
| 88 |
+
* https://huggingface.co/timm/csatv2_21m.sw_r640_in1k (83.13% top-1)
|
| 89 |
+
* https://huggingface.co/timm/csatv2_21m.sw_r512_in1k (82.58% top-1)
|
| 90 |
+
* Factor non-persistent param init out of `__init__` into a common method that can be externally called via `init_non_persistent_buffers()` after meta-device init.
|
| 91 |
+
|
| 92 |
+
## Dec 12, 2025
|
| 93 |
+
* Add CSATV2 model (thanks https://github.com/gusdlf93) -- a lightweight but high res model with DCT stem & spatial attention. https://huggingface.co/Hyunil/CSATv2
|
| 94 |
+
* Add AdaMuon and NAdaMuon optimizer support to existing `timm` Muon impl. Appears more competitive vs AdamW with familiar hparams for image tasks.
|
| 95 |
+
* End of year PR cleanup, merge aspects of several long open PR
|
| 96 |
+
* Merge differential attention (`DiffAttention`), add corresponding `DiffParallelScalingBlock` (for ViT), train some wee vits
|
| 97 |
+
* https://huggingface.co/timm/vit_dwee_patch16_reg1_gap_256.sbb_in1k
|
| 98 |
+
* https://huggingface.co/timm/vit_dpwee_patch16_reg1_gap_256.sbb_in1k
|
| 99 |
+
* Add a few pooling modules, `LsePlus` and `SimPool`
|
| 100 |
+
* Cleanup, optimize `DropBlock2d` (also add support to ByobNet based models)
|
| 101 |
+
* Bump unit tests to PyTorch 2.9.1 + Python 3.13 on upper end, lower still PyTorch 1.13 + Python 3.10
|
| 102 |
+
|
| 103 |
+
## Dec 1, 2025
|
| 104 |
+
* Add lightweight task abstraction, add logits and feature distillation support to train script via new tasks.
|
| 105 |
+
* Remove old APEX AMP support
|
| 106 |
+
|
| 107 |
+
## Nov 4, 2025
|
| 108 |
+
* Fix LayerScale / LayerScale2d init bug (init values ignored), introduced in 1.0.21. Thanks https://github.com/Ilya-Fradlin
|
| 109 |
+
* Release 1.0.22
|
| 110 |
+
|
| 111 |
+
## Oct 31, 2025 🎃
|
| 112 |
+
* Update imagenet & OOD variant result csv files to include a few new models and verify correctness over several torch & timm versions
|
| 113 |
+
* EfficientNet-X and EfficientNet-H B5 model weights added as part of a hparam search for AdamW vs Muon (still iterating on Muon runs)
|
| 114 |
+
|
| 115 |
+
## Oct 16-20, 2025
|
| 116 |
+
* Add an impl of the Muon optimizer (based on https://github.com/KellerJordan/Muon) with customizations
|
| 117 |
+
* extra flexibility and improved handling for conv weights and fallbacks for weight shapes not suited for orthogonalization
|
| 118 |
+
* small speedup for NS iterations by reducing allocs and using fused (b)add(b)mm ops
|
| 119 |
+
* by default uses AdamW (or NAdamW if `nesterov=True`) updates if muon not suitable for parameter shape (or excluded via param group flag)
|
| 120 |
+
* like torch impl, select from several LR scale adjustment fns via `adjust_lr_fn`
|
| 121 |
+
* select from several NS coefficient presets or specify your own via `ns_coefficients`
|
| 122 |
+
* First 2 steps of 'meta' device model initialization supported
|
| 123 |
+
* Fix several ops that were breaking creation under 'meta' device context
|
| 124 |
+
* Add device & dtype factory kwarg support to all models and modules (anything inherting from nn.Module) in `timm`
|
| 125 |
+
* License fields added to pretrained cfgs in code
|
| 126 |
+
* Release 1.0.21
|
| 127 |
+
|
| 128 |
+
## Sept 21, 2025
|
| 129 |
+
* Remap DINOv3 ViT weight tags from `lvd_1689m` -> `lvd1689m` to match (same for `sat_493m` -> `sat493m`)
|
| 130 |
+
* Release 1.0.20
|
| 131 |
+
|
| 132 |
+
## Sept 17, 2025
|
| 133 |
+
* DINOv3 (https://arxiv.org/abs/2508.10104) ConvNeXt and ViT models added. ConvNeXt models were mapped to existing `timm` model. ViT support done via the EVA base model w/ a new `RotaryEmbeddingDinoV3` to match the DINOv3 specific RoPE impl
|
| 134 |
+
* HuggingFace Hub: https://huggingface.co/collections/timm/timm-dinov3-68cb08bb0bee365973d52a4d
|
| 135 |
+
* MobileCLIP-2 (https://arxiv.org/abs/2508.20691) vision encoders. New MCI3/MCI4 FastViT variants added and weights mapped to existing FastViT and B, L/14 ViTs.
|
| 136 |
+
* MetaCLIP-2 Worldwide (https://arxiv.org/abs/2507.22062) ViT encoder weights added.
|
| 137 |
+
* SigLIP-2 (https://arxiv.org/abs/2502.14786) NaFlex ViT encoder weights added via timm NaFlexViT model.
|
| 138 |
+
* Misc fixes and contributions
|
| 139 |
+
|
| 140 |
+
## July 23, 2025
|
| 141 |
+
* Add `set_input_size()` method to EVA models, used by OpenCLIP 3.0.0 to allow resizing for timm based encoder models.
|
| 142 |
+
* Release 1.0.18, needed for PE-Core S & T models in OpenCLIP 3.0.0
|
| 143 |
+
* Fix small typing issue that broke Python 3.9 compat. 1.0.19 patch release.
|
| 144 |
+
|
| 145 |
+
## July 21, 2025
|
| 146 |
+
* ROPE support added to NaFlexViT. All models covered by the EVA base (`eva.py`) including EVA, EVA02, Meta PE ViT, `timm` SBB ViT w/ ROPE, and Naver ROPE-ViT can be now loaded in NaFlexViT when `use_naflex=True` passed at model creation time
|
| 147 |
+
* More Meta PE ViT encoders added, including small/tiny variants, lang variants w/ tiling, and more spatial variants.
|
| 148 |
+
* PatchDropout fixed with NaFlexViT and also w/ EVA models (regression after adding Naver ROPE-ViT)
|
| 149 |
+
* Fix XY order with grid_indexing='xy', impacted non-square image use in 'xy' mode (only ROPE-ViT and PE impacted).
|
| 150 |
+
|
| 151 |
+
## July 7, 2025
|
| 152 |
+
* MobileNet-v5 backbone tweaks for improved Google Gemma 3n behaviour (to pair with updated official weights)
|
| 153 |
+
* Add stem bias (zero'd in updated weights, compat break with old weights)
|
| 154 |
+
* GELU -> GELU (tanh approx). A minor change to be closer to JAX
|
| 155 |
+
* Add two arguments to layer-decay support, a min scale clamp and 'no optimization' scale threshold
|
| 156 |
+
* Add 'Fp32' LayerNorm, RMSNorm, SimpleNorm variants that can be enabled to force computation of norm in float32
|
| 157 |
+
* Some typing, argument cleanup for norm, norm+act layers done with above
|
| 158 |
+
* Support Naver ROPE-ViT (https://github.com/naver-ai/rope-vit) in `eva.py`, add RotaryEmbeddingMixed module for mixed mode, weights on HuggingFace Hub
|
| 159 |
+
|
| 160 |
+
|model |img_size|top1 |top5 |param_count|
|
| 161 |
+
|--------------------------------------------------|--------|------|------|-----------|
|
| 162 |
+
|vit_large_patch16_rope_mixed_ape_224.naver_in1k |224 |84.84 |97.122|304.4 |
|
| 163 |
+
|vit_large_patch16_rope_mixed_224.naver_in1k |224 |84.828|97.116|304.2 |
|
| 164 |
+
|vit_large_patch16_rope_ape_224.naver_in1k |224 |84.65 |97.154|304.37 |
|
| 165 |
+
|vit_large_patch16_rope_224.naver_in1k |224 |84.648|97.122|304.17 |
|
| 166 |
+
|vit_base_patch16_rope_mixed_ape_224.naver_in1k |224 |83.894|96.754|86.59 |
|
| 167 |
+
|vit_base_patch16_rope_mixed_224.naver_in1k |224 |83.804|96.712|86.44 |
|
| 168 |
+
|vit_base_patch16_rope_ape_224.naver_in1k |224 |83.782|96.61 |86.59 |
|
| 169 |
+
|vit_base_patch16_rope_224.naver_in1k |224 |83.718|96.672|86.43 |
|
| 170 |
+
|vit_small_patch16_rope_224.naver_in1k |224 |81.23 |95.022|21.98 |
|
| 171 |
+
|vit_small_patch16_rope_mixed_224.naver_in1k |224 |81.216|95.022|21.99 |
|
| 172 |
+
|vit_small_patch16_rope_ape_224.naver_in1k |224 |81.004|95.016|22.06 |
|
| 173 |
+
|vit_small_patch16_rope_mixed_ape_224.naver_in1k |224 |80.986|94.976|22.06 |
|
| 174 |
+
* Some cleanup of ROPE modules, helpers, and FX tracing leaf registration
|
| 175 |
+
* Preparing version 1.0.17 release
|
| 176 |
+
|
| 177 |
+
## June 26, 2025
|
| 178 |
+
* MobileNetV5 backbone (w/ encoder only variant) for [Gemma 3n](https://ai.google.dev/gemma/docs/gemma-3n#parameters) image encoder
|
| 179 |
+
* Version 1.0.16 released
|
| 180 |
+
|
| 181 |
+
## June 23, 2025
|
| 182 |
+
* Add F.grid_sample based 2D and factorized pos embed resize to NaFlexViT. Faster when lots of different sizes (based on example by https://github.com/stas-sl).
|
| 183 |
+
* Further speed up patch embed resample by replacing vmap with matmul (based on snippet by https://github.com/stas-sl).
|
| 184 |
+
* Add 3 initial native aspect NaFlexViT checkpoints created while testing, ImageNet-1k and 3 different pos embed configs w/ same hparams.
|
| 185 |
+
|
| 186 |
+
| Model | Top-1 Acc | Top-5 Acc | Params (M) | Eval Seq Len |
|
| 187 |
+
|:---|:---:|:---:|:---:|:---:|
|
| 188 |
+
| [naflexvit_base_patch16_par_gap.e300_s576_in1k](https://hf.co/timm/naflexvit_base_patch16_par_gap.e300_s576_in1k) | 83.67 | 96.45 | 86.63 | 576 |
|
| 189 |
+
| [naflexvit_base_patch16_parfac_gap.e300_s576_in1k](https://hf.co/timm/naflexvit_base_patch16_parfac_gap.e300_s576_in1k) | 83.63 | 96.41 | 86.46 | 576 |
|
| 190 |
+
| [naflexvit_base_patch16_gap.e300_s576_in1k](https://hf.co/timm/naflexvit_base_patch16_gap.e300_s576_in1k) | 83.50 | 96.46 | 86.63 | 576 |
|
| 191 |
+
* Support gradient checkpointing for `forward_intermediates` and fix some checkpointing bugs. Thanks https://github.com/brianhou0208
|
| 192 |
+
* Add 'corrected weight decay' (https://arxiv.org/abs/2506.02285) as option to AdamW (legacy), Adopt, Kron, Adafactor (BV), Lamb, LaProp, Lion, NadamW, RmsPropTF, SGDW optimizers
|
| 193 |
+
* Switch PE (perception encoder) ViT models to use native timm weights instead of remapping on the fly
|
| 194 |
+
* Fix cuda stream bug in prefetch loader
|
| 195 |
+
|
| 196 |
+
## June 5, 2025
|
| 197 |
+
* Initial NaFlexVit model code. NaFlexVit is a Vision Transformer with:
|
| 198 |
+
1. Encapsulated embedding and position encoding in a single module
|
| 199 |
+
2. Support for nn.Linear patch embedding on pre-patchified (dictionary) inputs
|
| 200 |
+
3. Support for NaFlex variable aspect, variable resolution (SigLip-2: https://arxiv.org/abs/2502.14786)
|
| 201 |
+
4. Support for FlexiViT variable patch size (https://arxiv.org/abs/2212.08013)
|
| 202 |
+
5. Support for NaViT fractional/factorized position embedding (https://arxiv.org/abs/2307.06304)
|
| 203 |
+
* Existing vit models in `vision_transformer.py` can be loaded into the NaFlexVit model by adding the `use_naflex=True` flag to `create_model`
|
| 204 |
+
* Some native weights coming soon
|
| 205 |
+
* A full NaFlex data pipeline is available that allows training / fine-tuning / evaluating with variable aspect / size images
|
| 206 |
+
* To enable in `train.py` and `validate.py` add the `--naflex-loader` arg, must be used with a NaFlexVit
|
| 207 |
+
* To evaluate an existing (classic) ViT loaded in NaFlexVit model w/ NaFlex data pipe:
|
| 208 |
+
* `python validate.py /imagenet --amp -j 8 --model vit_base_patch16_224 --model-kwargs use_naflex=True --naflex-loader --naflex-max-seq-len 256`
|
| 209 |
+
* The training has some extra args features worth noting
|
| 210 |
+
* The `--naflex-train-seq-lens'` argument specifies which sequence lengths to randomly pick from per batch during training
|
| 211 |
+
* The `--naflex-max-seq-len` argument sets the target sequence length for validation
|
| 212 |
+
* Adding `--model-kwargs enable_patch_interpolator=True --naflex-patch-sizes 12 16 24` will enable random patch size selection per-batch w/ interpolation
|
| 213 |
+
* The `--naflex-loss-scale` arg changes loss scaling mode per batch relative to the batch size, `timm` NaFlex loading changes the batch size for each seq len
|
| 214 |
+
|
| 215 |
+
## May 28, 2025
|
| 216 |
+
* Add a number of small/fast models thanks to https://github.com/brianhou0208
|
| 217 |
+
* SwiftFormer - [(ICCV2023) SwiftFormer: Efficient Additive Attention for Transformer-based Real-time Mobile Vision Applications](https://github.com/Amshaker/SwiftFormer)
|
| 218 |
+
* FasterNet - [(CVPR2023) Run, Don’t Walk: Chasing Higher FLOPS for Faster Neural Networks](https://github.com/JierunChen/FasterNet)
|
| 219 |
+
* SHViT - [(CVPR2024) SHViT: Single-Head Vision Transformer with Memory Efficient](https://github.com/ysj9909/SHViT)
|
| 220 |
+
* StarNet - [(CVPR2024) Rewrite the Stars](https://github.com/ma-xu/Rewrite-the-Stars)
|
| 221 |
+
* GhostNet-V3 [GhostNetV3: Exploring the Training Strategies for Compact Models](https://github.com/huawei-noah/Efficient-AI-Backbones/tree/master/ghostnetv3_pytorch)
|
| 222 |
+
* Update EVA ViT (closest match) to support Perception Encoder models (https://arxiv.org/abs/2504.13181) from Meta, loading Hub weights but I still need to push dedicated `timm` weights
|
| 223 |
+
* Add some flexibility to ROPE impl
|
| 224 |
+
* Big increase in number of models supporting `forward_intermediates()` and some additional fixes thanks to https://github.com/brianhou0208
|
| 225 |
+
* DaViT, EdgeNeXt, EfficientFormerV2, EfficientViT(MIT), EfficientViT(MSRA), FocalNet, GCViT, HGNet /V2, InceptionNeXt, Inception-V4, MambaOut, MetaFormer, NesT, Next-ViT, PiT, PVT V2, RepGhostNet, RepViT, ResNetV2, ReXNet, TinyViT, TResNet, VoV
|
| 226 |
+
* TNT model updated w/ new weights `forward_intermediates()` thanks to https://github.com/brianhou0208
|
| 227 |
+
* Add `local-dir:` pretrained schema, can use `local-dir:/path/to/model/folder` for model name to source model / pretrained cfg & weights Hugging Face Hub models (config.json + weights file) from a local folder.
|
| 228 |
+
* Fixes, improvements for onnx export
|
| 229 |
+
|
| 230 |
+
## Feb 21, 2025
|
| 231 |
+
* SigLIP 2 ViT image encoders added (https://huggingface.co/collections/timm/siglip-2-67b8e72ba08b09dd97aecaf9)
|
| 232 |
+
* Variable resolution / aspect NaFlex versions are a WIP
|
| 233 |
+
* Add 'SO150M2' ViT weights trained with SBB recipes, great results, better for ImageNet than previous attempt w/ less training.
|
| 234 |
+
* `vit_so150m2_patch16_reg1_gap_448.sbb_e200_in12k_ft_in1k` - 88.1% top-1
|
| 235 |
+
* `vit_so150m2_patch16_reg1_gap_384.sbb_e200_in12k_ft_in1k` - 87.9% top-1
|
| 236 |
+
* `vit_so150m2_patch16_reg1_gap_256.sbb_e200_in12k_ft_in1k` - 87.3% top-1
|
| 237 |
+
* `vit_so150m2_patch16_reg4_gap_256.sbb_e200_in12k`
|
| 238 |
+
* Updated InternViT-300M '2.5' weights
|
| 239 |
+
* Release 1.0.15
|
| 240 |
+
|
| 241 |
+
## Feb 1, 2025
|
| 242 |
+
* FYI PyTorch 2.6 & Python 3.13 are tested and working w/ current main and released version of `timm`
|
| 243 |
+
|
| 244 |
+
## Jan 27, 2025
|
| 245 |
+
* Add Kron Optimizer (PSGD w/ Kronecker-factored preconditioner)
|
| 246 |
+
* Code from https://github.com/evanatyourservice/kron_torch
|
| 247 |
+
* See also https://sites.google.com/site/lixilinx/home/psgd
|
| 248 |
+
|
| 249 |
+
## Jan 19, 2025
|
| 250 |
+
* Fix loading of LeViT safetensor weights, remove conversion code which should have been deactivated
|
| 251 |
+
* Add 'SO150M' ViT weights trained with SBB recipes, decent results, but not optimal shape for ImageNet-12k/1k pretrain/ft
|
| 252 |
+
* `vit_so150m_patch16_reg4_gap_256.sbb_e250_in12k_ft_in1k` - 86.7% top-1
|
| 253 |
+
* `vit_so150m_patch16_reg4_gap_384.sbb_e250_in12k_ft_in1k` - 87.4% top-1
|
| 254 |
+
* `vit_so150m_patch16_reg4_gap_256.sbb_e250_in12k`
|
| 255 |
+
* Misc typing, typo, etc. cleanup
|
| 256 |
+
* 1.0.14 release to get above LeViT fix out
|
| 257 |
+
|
| 258 |
+
## Jan 9, 2025
|
| 259 |
+
* Add support to train and validate in pure `bfloat16` or `float16`
|
| 260 |
+
* `wandb` project name arg added by https://github.com/caojiaolong, use arg.experiment for name
|
| 261 |
+
* Fix old issue w/ checkpoint saving not working on filesystem w/o hard-link support (e.g. FUSE fs mounts)
|
| 262 |
+
* 1.0.13 release
|
| 263 |
+
|
| 264 |
+
## Jan 6, 2025
|
| 265 |
+
* Add `torch.utils.checkpoint.checkpoint()` wrapper in `timm.models` that defaults `use_reentrant=False`, unless `TIMM_REENTRANT_CKPT=1` is set in env.
|
| 266 |
+
|
| 267 |
+
## Dec 31, 2024
|
| 268 |
+
* `convnext_nano` 384x384 ImageNet-12k pretrain & fine-tune. https://huggingface.co/models?search=convnext_nano%20r384
|
| 269 |
+
* Add AIM-v2 encoders from https://github.com/apple/ml-aim, see on Hub: https://huggingface.co/models?search=timm%20aimv2
|
| 270 |
+
* Add PaliGemma2 encoders from https://github.com/google-research/big_vision to existing PaliGemma, see on Hub: https://huggingface.co/models?search=timm%20pali2
|
| 271 |
+
* Add missing L/14 DFN2B 39B CLIP ViT, `vit_large_patch14_clip_224.dfn2b_s39b`
|
| 272 |
+
* Fix existing `RmsNorm` layer & fn to match standard formulation, use PT 2.5 impl when possible. Move old impl to `SimpleNorm` layer, it's LN w/o centering or bias. There were only two `timm` models using it, and they have been updated.
|
| 273 |
+
* Allow override of `cache_dir` arg for model creation
|
| 274 |
+
* Pass through `trust_remote_code` for HF datasets wrapper
|
| 275 |
+
* `inception_next_atto` model added by creator
|
| 276 |
+
* Adan optimizer caution, and Lamb decoupled weight decay options
|
| 277 |
+
* Some feature_info metadata fixed by https://github.com/brianhou0208
|
| 278 |
+
* All OpenCLIP and JAX (CLIP, SigLIP, Pali, etc) model weights that used load time remapping were given their own HF Hub instances so that they work with `hf-hub:` based loading, and thus will work with new Transformers `TimmWrapperModel`
|
| 279 |
+
|
| 280 |
+
## Introduction
|
| 281 |
+
|
| 282 |
+
Py**T**orch **Im**age **M**odels (`timm`) is a collection of image models, layers, utilities, optimizers, schedulers, data-loaders / augmentations, and reference training / validation scripts that aim to pull together a wide variety of SOTA models with ability to reproduce ImageNet training results.
|
| 283 |
+
|
| 284 |
+
The work of many others is present here. I've tried to make sure all source material is acknowledged via links to github, arxiv papers, etc in the README, documentation, and code docstrings. Please let me know if I missed anything.
|
| 285 |
+
|
| 286 |
+
## Features
|
| 287 |
+
|
| 288 |
+
### Models
|
| 289 |
+
|
| 290 |
+
All model architecture families include variants with pretrained weights. There are specific model variants without any weights, it is NOT a bug. Help training new or better weights is always appreciated.
|
| 291 |
+
|
| 292 |
+
* Aggregating Nested Transformers - https://arxiv.org/abs/2105.12723
|
| 293 |
+
* BEiT - https://arxiv.org/abs/2106.08254
|
| 294 |
+
* BEiT-V2 - https://arxiv.org/abs/2208.06366
|
| 295 |
+
* BEiT3 - https://arxiv.org/abs/2208.10442
|
| 296 |
+
* Big Transfer ResNetV2 (BiT) - https://arxiv.org/abs/1912.11370
|
| 297 |
+
* Bottleneck Transformers - https://arxiv.org/abs/2101.11605
|
| 298 |
+
* CaiT (Class-Attention in Image Transformers) - https://arxiv.org/abs/2103.17239
|
| 299 |
+
* CoaT (Co-Scale Conv-Attentional Image Transformers) - https://arxiv.org/abs/2104.06399
|
| 300 |
+
* CoAtNet (Convolution and Attention) - https://arxiv.org/abs/2106.04803
|
| 301 |
+
* ConvNeXt - https://arxiv.org/abs/2201.03545
|
| 302 |
+
* ConvNeXt-V2 - http://arxiv.org/abs/2301.00808
|
| 303 |
+
* ConViT (Soft Convolutional Inductive Biases Vision Transformers)- https://arxiv.org/abs/2103.10697
|
| 304 |
+
* CspNet (Cross-Stage Partial Networks) - https://arxiv.org/abs/1911.11929
|
| 305 |
+
* DeiT - https://arxiv.org/abs/2012.12877
|
| 306 |
+
* DeiT-III - https://arxiv.org/pdf/2204.07118.pdf
|
| 307 |
+
* DenseNet - https://arxiv.org/abs/1608.06993
|
| 308 |
+
* DLA - https://arxiv.org/abs/1707.06484
|
| 309 |
+
* DPN (Dual-Path Network) - https://arxiv.org/abs/1707.01629
|
| 310 |
+
* EdgeNeXt - https://arxiv.org/abs/2206.10589
|
| 311 |
+
* EfficientFormer - https://arxiv.org/abs/2206.01191
|
| 312 |
+
* EfficientFormer-V2 - https://arxiv.org/abs/2212.08059
|
| 313 |
+
* EfficientNet (MBConvNet Family)
|
| 314 |
+
* EfficientNet NoisyStudent (B0-B7, L2) - https://arxiv.org/abs/1911.04252
|
| 315 |
+
* EfficientNet AdvProp (B0-B8) - https://arxiv.org/abs/1911.09665
|
| 316 |
+
* EfficientNet (B0-B7) - https://arxiv.org/abs/1905.11946
|
| 317 |
+
* EfficientNet-EdgeTPU (S, M, L) - https://ai.googleblog.com/2019/08/efficientnet-edgetpu-creating.html
|
| 318 |
+
* EfficientNet V2 - https://arxiv.org/abs/2104.00298
|
| 319 |
+
* FBNet-C - https://arxiv.org/abs/1812.03443
|
| 320 |
+
* MixNet - https://arxiv.org/abs/1907.09595
|
| 321 |
+
* MNASNet B1, A1 (Squeeze-Excite), and Small - https://arxiv.org/abs/1807.11626
|
| 322 |
+
* MobileNet-V2 - https://arxiv.org/abs/1801.04381
|
| 323 |
+
* Single-Path NAS - https://arxiv.org/abs/1904.02877
|
| 324 |
+
* TinyNet - https://arxiv.org/abs/2010.14819
|
| 325 |
+
* EfficientViT (MIT) - https://arxiv.org/abs/2205.14756
|
| 326 |
+
* EfficientViT (MSRA) - https://arxiv.org/abs/2305.07027
|
| 327 |
+
* EVA - https://arxiv.org/abs/2211.07636
|
| 328 |
+
* EVA-02 - https://arxiv.org/abs/2303.11331
|
| 329 |
+
* FasterNet - https://arxiv.org/abs/2303.03667
|
| 330 |
+
* FastViT - https://arxiv.org/abs/2303.14189
|
| 331 |
+
* FlexiViT - https://arxiv.org/abs/2212.08013
|
| 332 |
+
* FocalNet (Focal Modulation Networks) - https://arxiv.org/abs/2203.11926
|
| 333 |
+
* GCViT (Global Context Vision Transformer) - https://arxiv.org/abs/2206.09959
|
| 334 |
+
* GhostNet - https://arxiv.org/abs/1911.11907
|
| 335 |
+
* GhostNet-V2 - https://arxiv.org/abs/2211.12905
|
| 336 |
+
* GhostNet-V3 - https://arxiv.org/abs/2404.11202
|
| 337 |
+
* gMLP - https://arxiv.org/abs/2105.08050
|
| 338 |
+
* GPU-Efficient Networks - https://arxiv.org/abs/2006.14090
|
| 339 |
+
* Halo Nets - https://arxiv.org/abs/2103.12731
|
| 340 |
+
* HGNet / HGNet-V2 - TBD
|
| 341 |
+
* HRNet - https://arxiv.org/abs/1908.07919
|
| 342 |
+
* InceptionNeXt - https://arxiv.org/abs/2303.16900
|
| 343 |
+
* Inception-V3 - https://arxiv.org/abs/1512.00567
|
| 344 |
+
* Inception-ResNet-V2 and Inception-V4 - https://arxiv.org/abs/1602.07261
|
| 345 |
+
* Lambda Networks - https://arxiv.org/abs/2102.08602
|
| 346 |
+
* LeViT (Vision Transformer in ConvNet's Clothing) - https://arxiv.org/abs/2104.01136
|
| 347 |
+
* MambaOut - https://arxiv.org/abs/2405.07992
|
| 348 |
+
* MaxViT (Multi-Axis Vision Transformer) - https://arxiv.org/abs/2204.01697
|
| 349 |
+
* MetaFormer (PoolFormer-v2, ConvFormer, CAFormer) - https://arxiv.org/abs/2210.13452
|
| 350 |
+
* MLP-Mixer - https://arxiv.org/abs/2105.01601
|
| 351 |
+
* MobileCLIP - https://arxiv.org/abs/2311.17049
|
| 352 |
+
* MobileNet-V3 (MBConvNet w/ Efficient Head) - https://arxiv.org/abs/1905.02244
|
| 353 |
+
* FBNet-V3 - https://arxiv.org/abs/2006.02049
|
| 354 |
+
* HardCoRe-NAS - https://arxiv.org/abs/2102.11646
|
| 355 |
+
* LCNet - https://arxiv.org/abs/2109.15099
|
| 356 |
+
* MobileNetV4 - https://arxiv.org/abs/2404.10518
|
| 357 |
+
* MobileOne - https://arxiv.org/abs/2206.04040
|
| 358 |
+
* MobileViT - https://arxiv.org/abs/2110.02178
|
| 359 |
+
* MobileViT-V2 - https://arxiv.org/abs/2206.02680
|
| 360 |
+
* MViT-V2 (Improved Multiscale Vision Transformer) - https://arxiv.org/abs/2112.01526
|
| 361 |
+
* NASNet-A - https://arxiv.org/abs/1707.07012
|
| 362 |
+
* NesT - https://arxiv.org/abs/2105.12723
|
| 363 |
+
* Next-ViT - https://arxiv.org/abs/2207.05501
|
| 364 |
+
* NFNet-F - https://arxiv.org/abs/2102.06171
|
| 365 |
+
* NF-RegNet / NF-ResNet - https://arxiv.org/abs/2101.08692
|
| 366 |
+
* PE (Perception Encoder) - https://arxiv.org/abs/2504.13181
|
| 367 |
+
* PNasNet - https://arxiv.org/abs/1712.00559
|
| 368 |
+
* PoolFormer (MetaFormer) - https://arxiv.org/abs/2111.11418
|
| 369 |
+
* Pooling-based Vision Transformer (PiT) - https://arxiv.org/abs/2103.16302
|
| 370 |
+
* PVT-V2 (Improved Pyramid Vision Transformer) - https://arxiv.org/abs/2106.13797
|
| 371 |
+
* RDNet (DenseNets Reloaded) - https://arxiv.org/abs/2403.19588
|
| 372 |
+
* RegNet - https://arxiv.org/abs/2003.13678
|
| 373 |
+
* RegNetZ - https://arxiv.org/abs/2103.06877
|
| 374 |
+
* RepVGG - https://arxiv.org/abs/2101.03697
|
| 375 |
+
* RepGhostNet - https://arxiv.org/abs/2211.06088
|
| 376 |
+
* RepViT - https://arxiv.org/abs/2307.09283
|
| 377 |
+
* ResMLP - https://arxiv.org/abs/2105.03404
|
| 378 |
+
* ResNet/ResNeXt
|
| 379 |
+
* ResNet (v1b/v1.5) - https://arxiv.org/abs/1512.03385
|
| 380 |
+
* ResNeXt - https://arxiv.org/abs/1611.05431
|
| 381 |
+
* 'Bag of Tricks' / Gluon C, D, E, S variations - https://arxiv.org/abs/1812.01187
|
| 382 |
+
* Weakly-supervised (WSL) Instagram pretrained / ImageNet tuned ResNeXt101 - https://arxiv.org/abs/1805.00932
|
| 383 |
+
* Semi-supervised (SSL) / Semi-weakly Supervised (SWSL) ResNet/ResNeXts - https://arxiv.org/abs/1905.00546
|
| 384 |
+
* ECA-Net (ECAResNet) - https://arxiv.org/abs/1910.03151v4
|
| 385 |
+
* Squeeze-and-Excitation Networks (SEResNet) - https://arxiv.org/abs/1709.01507
|
| 386 |
+
* ResNet-RS - https://arxiv.org/abs/2103.07579
|
| 387 |
+
* Res2Net - https://arxiv.org/abs/1904.01169
|
| 388 |
+
* ResNeSt - https://arxiv.org/abs/2004.08955
|
| 389 |
+
* ReXNet - https://arxiv.org/abs/2007.00992
|
| 390 |
+
* ROPE-ViT - https://arxiv.org/abs/2403.13298
|
| 391 |
+
* SelecSLS - https://arxiv.org/abs/1907.00837
|
| 392 |
+
* Selective Kernel Networks - https://arxiv.org/abs/1903.06586
|
| 393 |
+
* Sequencer2D - https://arxiv.org/abs/2205.01972
|
| 394 |
+
* SHViT - https://arxiv.org/abs/2401.16456
|
| 395 |
+
* SigLIP (image encoder) - https://arxiv.org/abs/2303.15343
|
| 396 |
+
* SigLIP 2 (image encoder) - https://arxiv.org/abs/2502.14786
|
| 397 |
+
* StarNet - https://arxiv.org/abs/2403.19967
|
| 398 |
+
* SwiftFormer - https://arxiv.org/pdf/2303.15446
|
| 399 |
+
* Swin S3 (AutoFormerV2) - https://arxiv.org/abs/2111.14725
|
| 400 |
+
* Swin Transformer - https://arxiv.org/abs/2103.14030
|
| 401 |
+
* Swin Transformer V2 - https://arxiv.org/abs/2111.09883
|
| 402 |
+
* TinyViT - https://arxiv.org/abs/2207.10666
|
| 403 |
+
* Transformer-iN-Transformer (TNT) - https://arxiv.org/abs/2103.00112
|
| 404 |
+
* TResNet - https://arxiv.org/abs/2003.13630
|
| 405 |
+
* Twins (Spatial Attention in Vision Transformers) - https://arxiv.org/pdf/2104.13840.pdf
|
| 406 |
+
* VGG - https://arxiv.org/abs/1409.1556
|
| 407 |
+
* Visformer - https://arxiv.org/abs/2104.12533
|
| 408 |
+
* Vision Transformer - https://arxiv.org/abs/2010.11929
|
| 409 |
+
* ViTamin - https://arxiv.org/abs/2404.02132
|
| 410 |
+
* VOLO (Vision Outlooker) - https://arxiv.org/abs/2106.13112
|
| 411 |
+
* VovNet V2 and V1 - https://arxiv.org/abs/1911.06667
|
| 412 |
+
* Xception - https://arxiv.org/abs/1610.02357
|
| 413 |
+
* Xception (Modified Aligned, Gluon) - https://arxiv.org/abs/1802.02611
|
| 414 |
+
* Xception (Modified Aligned, TF) - https://arxiv.org/abs/1802.02611
|
| 415 |
+
* XCiT (Cross-Covariance Image Transformers) - https://arxiv.org/abs/2106.09681
|
| 416 |
+
|
| 417 |
+
### Optimizers
|
| 418 |
+
To see full list of optimizers w/ descriptions: `timm.optim.list_optimizers(with_description=True)`
|
| 419 |
+
|
| 420 |
+
Included optimizers available via `timm.optim.create_optimizer_v2` factory method:
|
| 421 |
+
* `adabelief` an implementation of AdaBelief adapted from https://github.com/juntang-zhuang/Adabelief-Optimizer - https://arxiv.org/abs/2010.07468
|
| 422 |
+
* `adafactor` adapted from [FAIRSeq impl](https://github.com/pytorch/fairseq/blob/master/fairseq/optim/adafactor.py) - https://arxiv.org/abs/1804.04235
|
| 423 |
+
* `adafactorbv` adapted from [Big Vision](https://github.com/google-research/big_vision/blob/main/big_vision/optax.py) - https://arxiv.org/abs/2106.04560
|
| 424 |
+
* `adahessian` by [David Samuel](https://github.com/davda54/ada-hessian) - https://arxiv.org/abs/2006.00719
|
| 425 |
+
* `adamp` and `sgdp` by [Naver ClovAI](https://github.com/clovaai) - https://arxiv.org/abs/2006.08217
|
| 426 |
+
* `adamuon` and `nadamuon` as per https://github.com/Chongjie-Si/AdaMuon - https://arxiv.org/abs/2507.11005
|
| 427 |
+
* `adan` an implementation of Adan adapted from https://github.com/sail-sg/Adan - https://arxiv.org/abs/2208.06677
|
| 428 |
+
* `adopt` ADOPT adapted from https://github.com/iShohei220/adopt - https://arxiv.org/abs/2411.02853
|
| 429 |
+
* `kron` PSGD w/ Kronecker-factored preconditioner from https://github.com/evanatyourservice/kron_torch - https://sites.google.com/site/lixilinx/home/psgd
|
| 430 |
+
* `lamb` an implementation of Lamb and LambC (w/ trust-clipping) cleaned up and modified to support use with XLA - https://arxiv.org/abs/1904.00962
|
| 431 |
+
* `laprop` optimizer from https://github.com/Z-T-WANG/LaProp-Optimizer - https://arxiv.org/abs/2002.04839
|
| 432 |
+
* `lars` an implementation of LARS and LARC (w/ trust-clipping) - https://arxiv.org/abs/1708.03888
|
| 433 |
+
* `lion` and implementation of Lion adapted from https://github.com/google/automl/tree/master/lion - https://arxiv.org/abs/2302.06675
|
| 434 |
+
* `lookahead` adapted from impl by [Liam](https://github.com/alphadl/lookahead.pytorch) - https://arxiv.org/abs/1907.08610
|
| 435 |
+
* `madgrad` an implementation of MADGRAD adapted from https://github.com/facebookresearch/madgrad - https://arxiv.org/abs/2101.11075
|
| 436 |
+
* `mars` MARS optimizer from https://github.com/AGI-Arena/MARS - https://arxiv.org/abs/2411.10438
|
| 437 |
+
* `muon` MUON optimizer from https://github.com/KellerJordan/Muon with numerous additions and improved non-transformer behaviour
|
| 438 |
+
* `nadam` an implementation of Adam w/ Nesterov momentum
|
| 439 |
+
* `nadamw` an implementation of AdamW (Adam w/ decoupled weight-decay) w/ Nesterov momentum. A simplified impl based on https://github.com/mlcommons/algorithmic-efficiency
|
| 440 |
+
* `novograd` by [Masashi Kimura](https://github.com/convergence-lab/novograd) - https://arxiv.org/abs/1905.11286
|
| 441 |
+
* `radam` by [Liyuan Liu](https://github.com/LiyuanLucasLiu/RAdam) - https://arxiv.org/abs/1908.03265
|
| 442 |
+
* `rmsprop_tf` adapted from PyTorch RMSProp by myself. Reproduces much improved Tensorflow RMSProp behaviour
|
| 443 |
+
* `sgdw` and implementation of SGD w/ decoupled weight-decay
|
| 444 |
+
* `fused<name>` optimizers by name with [NVIDIA Apex](https://github.com/NVIDIA/apex/tree/master/apex/optimizers) installed
|
| 445 |
+
* `bnb<name>` optimizers by name with [BitsAndBytes](https://github.com/TimDettmers/bitsandbytes) installed
|
| 446 |
+
* `cadamw`, `clion`, and more 'Cautious' optimizers from https://github.com/kyleliang919/C-Optim - https://arxiv.org/abs/2411.16085
|
| 447 |
+
* `adam`, `adamw`, `rmsprop`, `adadelta`, `adagrad`, and `sgd` pass through to `torch.optim` implementations
|
| 448 |
+
* `c` suffix (eg `adamc`, `nadamc` to implement 'corrected weight decay' in https://arxiv.org/abs/2506.02285)
|
| 449 |
+
|
| 450 |
+
### Augmentations
|
| 451 |
+
* Random Erasing from [Zhun Zhong](https://github.com/zhunzhong07/Random-Erasing/blob/master/transforms.py) - https://arxiv.org/abs/1708.04896)
|
| 452 |
+
* Mixup - https://arxiv.org/abs/1710.09412
|
| 453 |
+
* CutMix - https://arxiv.org/abs/1905.04899
|
| 454 |
+
* AutoAugment (https://arxiv.org/abs/1805.09501) and RandAugment (https://arxiv.org/abs/1909.13719) ImageNet configurations modeled after impl for EfficientNet training (https://github.com/tensorflow/tpu/blob/master/models/official/efficientnet/autoaugment.py)
|
| 455 |
+
* AugMix w/ JSD loss, JSD w/ clean + augmented mixing support works with AutoAugment and RandAugment as well - https://arxiv.org/abs/1912.02781
|
| 456 |
+
* SplitBachNorm - allows splitting batch norm layers between clean and augmented (auxiliary batch norm) data
|
| 457 |
+
|
| 458 |
+
### Regularization
|
| 459 |
+
* DropPath aka "Stochastic Depth" - https://arxiv.org/abs/1603.09382
|
| 460 |
+
* DropBlock - https://arxiv.org/abs/1810.12890
|
| 461 |
+
* Blur Pooling - https://arxiv.org/abs/1904.11486
|
| 462 |
+
|
| 463 |
+
### Other
|
| 464 |
+
|
| 465 |
+
Several (less common) features that I often utilize in my projects are included. Many of their additions are the reason why I maintain my own set of models, instead of using others' via PIP:
|
| 466 |
+
|
| 467 |
+
* All models have a common default configuration interface and API for
|
| 468 |
+
* accessing/changing the classifier - `get_classifier` and `reset_classifier`
|
| 469 |
+
* doing a forward pass on just the features - `forward_features` (see [documentation](https://huggingface.co/docs/timm/feature_extraction))
|
| 470 |
+
* these makes it easy to write consistent network wrappers that work with any of the models
|
| 471 |
+
* All models support multi-scale feature map extraction (feature pyramids) via create_model (see [documentation](https://huggingface.co/docs/timm/feature_extraction))
|
| 472 |
+
* `create_model(name, features_only=True, out_indices=..., output_stride=...)`
|
| 473 |
+
* `out_indices` creation arg specifies which feature maps to return, these indices are 0 based and generally correspond to the `C(i + 1)` feature level.
|
| 474 |
+
* `output_stride` creation arg controls output stride of the network by using dilated convolutions. Most networks are stride 32 by default. Not all networks support this.
|
| 475 |
+
* feature map channel counts, reduction level (stride) can be queried AFTER model creation via the `.feature_info` member
|
| 476 |
+
* All models have a consistent pretrained weight loader that adapts last linear if necessary, and from 3 to 1 channel input if desired
|
| 477 |
+
* High performance [reference training, validation, and inference scripts](https://huggingface.co/docs/timm/training_script) that work in several process/GPU modes:
|
| 478 |
+
* NVIDIA DDP w/ a single GPU per process, multiple processes with APEX present (AMP mixed-precision optional)
|
| 479 |
+
* PyTorch DistributedDataParallel w/ multi-gpu, single process (AMP disabled as it crashes when enabled)
|
| 480 |
+
* PyTorch w/ single GPU single process (AMP optional)
|
| 481 |
+
* A dynamic global pool implementation that allows selecting from average pooling, max pooling, average + max, or concat([average, max]) at model creation. All global pooling is adaptive average by default and compatible with pretrained weights.
|
| 482 |
+
* A 'Test Time Pool' wrapper that can wrap any of the included models and usually provides improved performance doing inference with input images larger than the training size. Idea adapted from original DPN implementation when I ported (https://github.com/cypw/DPNs)
|
| 483 |
+
* Learning rate schedulers
|
| 484 |
+
* Ideas adopted from
|
| 485 |
+
* [AllenNLP schedulers](https://github.com/allenai/allennlp/tree/master/allennlp/training/learning_rate_schedulers)
|
| 486 |
+
* [FAIRseq lr_scheduler](https://github.com/pytorch/fairseq/tree/master/fairseq/optim/lr_scheduler)
|
| 487 |
+
* SGDR: Stochastic Gradient Descent with Warm Restarts (https://arxiv.org/abs/1608.03983)
|
| 488 |
+
* Schedulers include `step`, `cosine` w/ restarts, `tanh` w/ restarts, `plateau`
|
| 489 |
+
* Space-to-Depth by [mrT23](https://github.com/mrT23/TResNet/blob/master/src/models/tresnet/layers/space_to_depth.py) (https://arxiv.org/abs/1801.04590)
|
| 490 |
+
* Adaptive Gradient Clipping (https://arxiv.org/abs/2102.06171, https://github.com/deepmind/deepmind-research/tree/master/nfnets)
|
| 491 |
+
* An extensive selection of channel and/or spatial attention modules:
|
| 492 |
+
* Bottleneck Transformer - https://arxiv.org/abs/2101.11605
|
| 493 |
+
* CBAM - https://arxiv.org/abs/1807.06521
|
| 494 |
+
* Effective Squeeze-Excitation (ESE) - https://arxiv.org/abs/1911.06667
|
| 495 |
+
* Efficient Channel Attention (ECA) - https://arxiv.org/abs/1910.03151
|
| 496 |
+
* Gather-Excite (GE) - https://arxiv.org/abs/1810.12348
|
| 497 |
+
* Global Context (GC) - https://arxiv.org/abs/1904.11492
|
| 498 |
+
* Halo - https://arxiv.org/abs/2103.12731
|
| 499 |
+
* Involution - https://arxiv.org/abs/2103.06255
|
| 500 |
+
* Lambda Layer - https://arxiv.org/abs/2102.08602
|
| 501 |
+
* Non-Local (NL) - https://arxiv.org/abs/1711.07971
|
| 502 |
+
* Squeeze-and-Excitation (SE) - https://arxiv.org/abs/1709.01507
|
| 503 |
+
* Selective Kernel (SK) - (https://arxiv.org/abs/1903.06586
|
| 504 |
+
* Split (SPLAT) - https://arxiv.org/abs/2004.08955
|
| 505 |
+
* Shifted Window (SWIN) - https://arxiv.org/abs/2103.14030
|
| 506 |
+
|
| 507 |
+
## Results
|
| 508 |
+
|
| 509 |
+
Model validation results can be found in the [results tables](results/README.md)
|
| 510 |
+
|
| 511 |
+
## Getting Started (Documentation)
|
| 512 |
+
|
| 513 |
+
The official documentation can be found at https://huggingface.co/docs/hub/timm. Documentation contributions are welcome.
|
| 514 |
+
|
| 515 |
+
[Getting Started with PyTorch Image Models (timm): A Practitioner’s Guide](https://towardsdatascience.com/getting-started-with-pytorch-image-models-timm-a-practitioners-guide-4e77b4bf9055-2/) by [Chris Hughes](https://github.com/Chris-hughes10) is an extensive blog post covering many aspects of `timm` in detail.
|
| 516 |
+
|
| 517 |
+
[timmdocs](http://timm.fast.ai/) is an alternate set of documentation for `timm`. A big thanks to [Aman Arora](https://github.com/amaarora) for his efforts creating timmdocs.
|
| 518 |
+
|
| 519 |
+
[paperswithcode](https://paperswithcode.com/lib/timm) is a good resource for browsing the models within `timm`.
|
| 520 |
+
|
| 521 |
+
## Train, Validation, Inference Scripts
|
| 522 |
+
|
| 523 |
+
The root folder of the repository contains reference train, validation, and inference scripts that work with the included models and other features of this repository. They are adaptable for other datasets and use cases with a little hacking. See [documentation](https://huggingface.co/docs/timm/training_script).
|
| 524 |
+
|
| 525 |
+
## Awesome PyTorch Resources
|
| 526 |
+
|
| 527 |
+
One of the greatest assets of PyTorch is the community and their contributions. A few of my favourite resources that pair well with the models and components here are listed below.
|
| 528 |
+
|
| 529 |
+
### Object Detection, Instance and Semantic Segmentation
|
| 530 |
+
* Detectron2 - https://github.com/facebookresearch/detectron2
|
| 531 |
+
* Segmentation Models (Semantic) - https://github.com/qubvel/segmentation_models.pytorch
|
| 532 |
+
* EfficientDet (Obj Det, Semantic soon) - https://github.com/rwightman/efficientdet-pytorch
|
| 533 |
+
|
| 534 |
+
### Computer Vision / Image Augmentation
|
| 535 |
+
* Albumentations - https://github.com/albumentations-team/albumentations
|
| 536 |
+
* Kornia - https://github.com/kornia/kornia
|
| 537 |
+
|
| 538 |
+
### Knowledge Distillation
|
| 539 |
+
* RepDistiller - https://github.com/HobbitLong/RepDistiller
|
| 540 |
+
* torchdistill - https://github.com/yoshitomo-matsubara/torchdistill
|
| 541 |
+
|
| 542 |
+
### Metric Learning
|
| 543 |
+
* PyTorch Metric Learning - https://github.com/KevinMusgrave/pytorch-metric-learning
|
| 544 |
+
|
| 545 |
+
### Training / Frameworks
|
| 546 |
+
* fastai - https://github.com/fastai/fastai
|
| 547 |
+
* lightly_train - https://github.com/lightly-ai/lightly-train
|
| 548 |
+
|
| 549 |
+
### Deployment
|
| 550 |
+
* timmx (Export timm models to ONNX, CoreML, LiteRT, TensorRT, and more) - https://github.com/Boulaouaney/timmx
|
| 551 |
+
|
| 552 |
+
## Licenses
|
| 553 |
+
|
| 554 |
+
### Code
|
| 555 |
+
The code here is licensed Apache 2.0. I've taken care to make sure any third party code included or adapted has compatible (permissive) licenses such as MIT, BSD, etc. I've made an effort to avoid any GPL / LGPL conflicts. That said, it is your responsibility to ensure you comply with licenses here and conditions of any dependent licenses. Where applicable, I've linked the sources/references for various components in docstrings. If you think I've missed anything please create an issue.
|
| 556 |
+
|
| 557 |
+
### Pretrained Weights
|
| 558 |
+
So far all of the pretrained weights available here are pretrained on ImageNet with a select few that have some additional pretraining (see extra note below). ImageNet was released for non-commercial research purposes only (https://image-net.org/download). It's not clear what the implications of that are for the use of pretrained weights from that dataset. Any models I have trained with ImageNet are done for research purposes and one should assume that the original dataset license applies to the weights. It's best to seek legal advice if you intend to use the pretrained weights in a commercial product.
|
| 559 |
+
|
| 560 |
+
#### Pretrained on more than ImageNet
|
| 561 |
+
Several weights included or references here were pretrained with proprietary datasets that I do not have access to. These include the Facebook WSL, SSL, SWSL ResNe(Xt) and the Google Noisy Student EfficientNet models. The Facebook models have an explicit non-commercial license (CC-BY-NC 4.0, https://github.com/facebookresearch/semi-supervised-ImageNet1K-models, https://github.com/facebookresearch/WSL-Images). The Google models do not appear to have any restriction beyond the Apache 2.0 license (and ImageNet concerns). In either case, you should contact Facebook or Google with any questions.
|
| 562 |
+
|
| 563 |
+
## Citing
|
| 564 |
+
|
| 565 |
+
### BibTeX
|
| 566 |
+
|
| 567 |
+
```bibtex
|
| 568 |
+
@misc{rw2019timm,
|
| 569 |
+
author = {Ross Wightman},
|
| 570 |
+
title = {PyTorch Image Models},
|
| 571 |
+
year = {2019},
|
| 572 |
+
publisher = {GitHub},
|
| 573 |
+
journal = {GitHub repository},
|
| 574 |
+
doi = {10.5281/zenodo.4414861},
|
| 575 |
+
howpublished = {\url{https://github.com/rwightman/pytorch-image-models}}
|
| 576 |
+
}
|
| 577 |
+
```
|
| 578 |
+
|
| 579 |
+
### Latest DOI
|
| 580 |
+
|
| 581 |
+
[](https://zenodo.org/badge/latestdoi/168799526)
|
.cache/pip/http-v2/2/b/d/2/a/2bd2afb46be8ef29cc0dd505de4aff907384c53895a0fbbce798558e
ADDED
|
Binary file (1.3 kB). View file
|
|
|
.cache/pip/http-v2/2/b/d/2/a/2bd2afb46be8ef29cc0dd505de4aff907384c53895a0fbbce798558e.body
ADDED
|
@@ -0,0 +1,354 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Metadata-Version: 2.4
|
| 2 |
+
Name: optuna
|
| 3 |
+
Version: 4.9.0
|
| 4 |
+
Summary: A hyperparameter optimization framework
|
| 5 |
+
Author: Takuya Akiba
|
| 6 |
+
Project-URL: homepage, https://optuna.org/
|
| 7 |
+
Project-URL: repository, https://github.com/optuna/optuna
|
| 8 |
+
Project-URL: documentation, https://optuna.readthedocs.io
|
| 9 |
+
Project-URL: bugtracker, https://github.com/optuna/optuna/issues
|
| 10 |
+
Classifier: Development Status :: 5 - Production/Stable
|
| 11 |
+
Classifier: Intended Audience :: Science/Research
|
| 12 |
+
Classifier: Intended Audience :: Developers
|
| 13 |
+
Classifier: License :: OSI Approved :: MIT License
|
| 14 |
+
Classifier: Programming Language :: Python :: 3
|
| 15 |
+
Classifier: Programming Language :: Python :: 3.9
|
| 16 |
+
Classifier: Programming Language :: Python :: 3.10
|
| 17 |
+
Classifier: Programming Language :: Python :: 3.11
|
| 18 |
+
Classifier: Programming Language :: Python :: 3.12
|
| 19 |
+
Classifier: Programming Language :: Python :: 3.13
|
| 20 |
+
Classifier: Programming Language :: Python :: 3.14
|
| 21 |
+
Classifier: Programming Language :: Python :: 3 :: Only
|
| 22 |
+
Classifier: Topic :: Scientific/Engineering
|
| 23 |
+
Classifier: Topic :: Scientific/Engineering :: Mathematics
|
| 24 |
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
| 25 |
+
Classifier: Topic :: Software Development
|
| 26 |
+
Classifier: Topic :: Software Development :: Libraries
|
| 27 |
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
| 28 |
+
Requires-Python: >=3.9
|
| 29 |
+
Description-Content-Type: text/markdown
|
| 30 |
+
License-File: LICENSE
|
| 31 |
+
License-File: LICENSE_THIRD_PARTY
|
| 32 |
+
Requires-Dist: alembic>=1.5.0
|
| 33 |
+
Requires-Dist: colorlog
|
| 34 |
+
Requires-Dist: numpy
|
| 35 |
+
Requires-Dist: packaging>=20.0
|
| 36 |
+
Requires-Dist: sqlalchemy>=1.4.2
|
| 37 |
+
Requires-Dist: tqdm
|
| 38 |
+
Requires-Dist: PyYAML
|
| 39 |
+
Provides-Extra: document
|
| 40 |
+
Requires-Dist: ase; extra == "document"
|
| 41 |
+
Requires-Dist: cmaes>=0.12.0; extra == "document"
|
| 42 |
+
Requires-Dist: fvcore; extra == "document"
|
| 43 |
+
Requires-Dist: kaleido!=0.2.1.post1,<0.4; extra == "document"
|
| 44 |
+
Requires-Dist: lightgbm; extra == "document"
|
| 45 |
+
Requires-Dist: matplotlib!=3.6.0; extra == "document"
|
| 46 |
+
Requires-Dist: pandas; extra == "document"
|
| 47 |
+
Requires-Dist: pillow; extra == "document"
|
| 48 |
+
Requires-Dist: plotly>=4.9.0; extra == "document"
|
| 49 |
+
Requires-Dist: scikit-learn; extra == "document"
|
| 50 |
+
Requires-Dist: sphinx; extra == "document"
|
| 51 |
+
Requires-Dist: sphinx-copybutton; extra == "document"
|
| 52 |
+
Requires-Dist: sphinx-gallery; extra == "document"
|
| 53 |
+
Requires-Dist: sphinx-notfound-page; extra == "document"
|
| 54 |
+
Requires-Dist: sphinx_rtd_theme>=1.2.0; extra == "document"
|
| 55 |
+
Requires-Dist: torch; extra == "document"
|
| 56 |
+
Requires-Dist: torchvision; extra == "document"
|
| 57 |
+
Provides-Extra: optional
|
| 58 |
+
Requires-Dist: boto3; extra == "optional"
|
| 59 |
+
Requires-Dist: cmaes>=0.12.0; extra == "optional"
|
| 60 |
+
Requires-Dist: google-cloud-storage; extra == "optional"
|
| 61 |
+
Requires-Dist: matplotlib!=3.6.0; extra == "optional"
|
| 62 |
+
Requires-Dist: pandas; extra == "optional"
|
| 63 |
+
Requires-Dist: plotly>=4.9.0; extra == "optional"
|
| 64 |
+
Requires-Dist: redis; extra == "optional"
|
| 65 |
+
Requires-Dist: scikit-learn>=0.24.2; extra == "optional"
|
| 66 |
+
Requires-Dist: scipy; extra == "optional"
|
| 67 |
+
Requires-Dist: torch; extra == "optional"
|
| 68 |
+
Requires-Dist: greenlet; extra == "optional"
|
| 69 |
+
Requires-Dist: grpcio; extra == "optional"
|
| 70 |
+
Requires-Dist: protobuf>=5.28.1; extra == "optional"
|
| 71 |
+
Dynamic: license-file
|
| 72 |
+
|
| 73 |
+
<div align="center"><img src="https://raw.githubusercontent.com/optuna/optuna/master/docs/image/optuna-logo.png" width="800"/></div>
|
| 74 |
+
|
| 75 |
+
# Optuna: A hyperparameter optimization framework
|
| 76 |
+
|
| 77 |
+
[](https://www.python.org)
|
| 78 |
+
[](https://pypi.python.org/pypi/optuna)
|
| 79 |
+
[](https://anaconda.org/conda-forge/optuna)
|
| 80 |
+
[](https://github.com/optuna/optuna)
|
| 81 |
+
[](https://optuna.readthedocs.io/en/stable/)
|
| 82 |
+
|
| 83 |
+
:link: [**Website**](https://optuna.org/)
|
| 84 |
+
| :page_with_curl: [**Docs**](https://optuna.readthedocs.io/en/stable/)
|
| 85 |
+
| :gear: [**Install Guide**](https://optuna.readthedocs.io/en/stable/installation.html)
|
| 86 |
+
| :pencil: [**Tutorial**](https://optuna.readthedocs.io/en/stable/tutorial/index.html)
|
| 87 |
+
| :bulb: [**Examples**](https://github.com/optuna/optuna-examples)
|
| 88 |
+
| [**Twitter**](https://twitter.com/OptunaAutoML)
|
| 89 |
+
| [**LinkedIn**](https://www.linkedin.com/showcase/optuna/)
|
| 90 |
+
| [**Medium**](https://medium.com/optuna)
|
| 91 |
+
|
| 92 |
+
*Optuna* is an automatic hyperparameter optimization software framework, particularly designed
|
| 93 |
+
for machine learning. It features an imperative, *define-by-run* style user API. Thanks to our
|
| 94 |
+
*define-by-run* API, the code written with Optuna enjoys high modularity, and the user of
|
| 95 |
+
Optuna can dynamically construct the search spaces for the hyperparameters.
|
| 96 |
+
|
| 97 |
+
## :loudspeaker: News
|
| 98 |
+
|
| 99 |
+
<!-- TODO: when you add a new line, please delete the oldest line -->
|
| 100 |
+
* **Mar 16, 2026**: Optuna 4.8.0 is out! Check out [the release note](https://github.com/optuna/optuna/releases/tag/v4.8.0) for details.
|
| 101 |
+
* **Jan 19, 2026**: Optuna 4.7.0 is out! Check out [the release note](https://github.com/optuna/optuna/releases/tag/v4.7.0) for details.
|
| 102 |
+
* **Nov 10, 2025**: A new article [Announcing Optuna 4.6](https://medium.com/optuna/announcing-optuna-4-6-a9e82183ab07) has been published.
|
| 103 |
+
* **Oct 28, 2025**: A new article [AutoSampler: Full Support for Multi-Objective & Constrained Optimization](https://medium.com/optuna/autosampler-full-support-for-multi-objective-constrained-optimization-c1c4fc957ba2) has been published.
|
| 104 |
+
* **Sep 22, 2025**: A new article [[Optuna v4.5] Gaussian Process-Based Sampler (GPSampler) Can Now Perform Constrained Multi-Objective Optimization](https://medium.com/optuna/optuna-v4-5-81e78d8e077a) has been published.
|
| 105 |
+
* **Jun 16, 2025**: Optuna 4.4.0 has been released! Check out [the release blog](https://medium.com/optuna/announcing-optuna-4-4-ece661493126).
|
| 106 |
+
|
| 107 |
+
## :fire: Key Features
|
| 108 |
+
|
| 109 |
+
Optuna has modern functionalities as follows:
|
| 110 |
+
|
| 111 |
+
- [Lightweight, versatile, and platform agnostic architecture](https://optuna.readthedocs.io/en/stable/tutorial/10_key_features/001_first.html)
|
| 112 |
+
- Handle a wide variety of tasks with a simple installation that has few requirements.
|
| 113 |
+
- [Pythonic search spaces](https://optuna.readthedocs.io/en/stable/tutorial/10_key_features/002_configurations.html)
|
| 114 |
+
- Define search spaces using familiar Python syntax including conditionals and loops.
|
| 115 |
+
- [Efficient optimization algorithms](https://optuna.readthedocs.io/en/stable/tutorial/10_key_features/003_efficient_optimization_algorithms.html)
|
| 116 |
+
- Adopt state-of-the-art algorithms for sampling hyperparameters and efficiently pruning unpromising trials.
|
| 117 |
+
- [Easy parallelization](https://optuna.readthedocs.io/en/stable/tutorial/10_key_features/004_distributed.html)
|
| 118 |
+
- Scale studies to tens or hundreds of workers with little or no changes to the code.
|
| 119 |
+
- [Quick visualization](https://optuna.readthedocs.io/en/stable/tutorial/10_key_features/005_visualization.html)
|
| 120 |
+
- Inspect optimization histories from a variety of plotting functions.
|
| 121 |
+
|
| 122 |
+
|
| 123 |
+
## Basic Concepts
|
| 124 |
+
|
| 125 |
+
We use the terms *study* and *trial* as follows:
|
| 126 |
+
|
| 127 |
+
- Study: optimization based on an objective function
|
| 128 |
+
- Trial: a single execution of the objective function
|
| 129 |
+
|
| 130 |
+
Please refer to the sample code below. The goal of a *study* is to find out the optimal set of
|
| 131 |
+
hyperparameter values (e.g., `regressor` and `svr_c`) through multiple *trials* (e.g.,
|
| 132 |
+
`n_trials=100`). Optuna is a framework designed for automation and acceleration of
|
| 133 |
+
optimization *studies*.
|
| 134 |
+
|
| 135 |
+
<details open>
|
| 136 |
+
<summary>Sample code with scikit-learn</summary>
|
| 137 |
+
|
| 138 |
+
[](http://colab.research.google.com/github/optuna/optuna-examples/blob/main/quickstart.ipynb)
|
| 139 |
+
|
| 140 |
+
```python
|
| 141 |
+
import optuna
|
| 142 |
+
import sklearn
|
| 143 |
+
|
| 144 |
+
|
| 145 |
+
# Define an objective function to be minimized.
|
| 146 |
+
def objective(trial):
|
| 147 |
+
|
| 148 |
+
# Invoke suggest methods of a Trial object to generate hyperparameters.
|
| 149 |
+
regressor_name = trial.suggest_categorical("regressor", ["SVR", "RandomForest"])
|
| 150 |
+
if regressor_name == "SVR":
|
| 151 |
+
svr_c = trial.suggest_float("svr_c", 1e-10, 1e10, log=True)
|
| 152 |
+
regressor_obj = sklearn.svm.SVR(C=svr_c)
|
| 153 |
+
else:
|
| 154 |
+
rf_max_depth = trial.suggest_int("rf_max_depth", 2, 32)
|
| 155 |
+
regressor_obj = sklearn.ensemble.RandomForestRegressor(max_depth=rf_max_depth)
|
| 156 |
+
|
| 157 |
+
X, y = sklearn.datasets.fetch_california_housing(return_X_y=True)
|
| 158 |
+
X_train, X_val, y_train, y_val = sklearn.model_selection.train_test_split(X, y, random_state=0)
|
| 159 |
+
|
| 160 |
+
regressor_obj.fit(X_train, y_train)
|
| 161 |
+
y_pred = regressor_obj.predict(X_val)
|
| 162 |
+
|
| 163 |
+
error = sklearn.metrics.mean_squared_error(y_val, y_pred)
|
| 164 |
+
|
| 165 |
+
return error # An objective value linked with the Trial object.
|
| 166 |
+
|
| 167 |
+
|
| 168 |
+
study = optuna.create_study() # Create a new study.
|
| 169 |
+
study.optimize(objective, n_trials=100) # Invoke optimization of the objective function.
|
| 170 |
+
```
|
| 171 |
+
</details>
|
| 172 |
+
|
| 173 |
+
> [!NOTE]
|
| 174 |
+
> More examples can be found in [optuna/optuna-examples](https://github.com/optuna/optuna-examples).
|
| 175 |
+
>
|
| 176 |
+
> The examples cover diverse problem setups such as multi-objective optimization, constrained optimization, pruning, and distributed optimization.
|
| 177 |
+
|
| 178 |
+
## Installation
|
| 179 |
+
|
| 180 |
+
Optuna is available at [the Python Package Index](https://pypi.org/project/optuna/) and on [Anaconda Cloud](https://anaconda.org/conda-forge/optuna).
|
| 181 |
+
|
| 182 |
+
```bash
|
| 183 |
+
# PyPI
|
| 184 |
+
$ pip install optuna
|
| 185 |
+
```
|
| 186 |
+
|
| 187 |
+
```bash
|
| 188 |
+
# Anaconda Cloud
|
| 189 |
+
$ conda install -c conda-forge optuna
|
| 190 |
+
```
|
| 191 |
+
|
| 192 |
+
> [!IMPORTANT]
|
| 193 |
+
> Optuna supports Python 3.9 or newer.
|
| 194 |
+
|
| 195 |
+
## Integrations
|
| 196 |
+
|
| 197 |
+
Optuna has integration features with various third-party libraries. Integrations can be found in [optuna/optuna-integration](https://github.com/optuna/optuna-integration) and the document is available [here](https://optuna-integration.readthedocs.io/en/stable/index.html).
|
| 198 |
+
|
| 199 |
+
<details>
|
| 200 |
+
<summary>Supported integration libraries</summary>
|
| 201 |
+
|
| 202 |
+
* [Catboost](https://github.com/optuna/optuna-examples/tree/main/catboost/catboost_pruning.py)
|
| 203 |
+
* [Dask](https://github.com/optuna/optuna-examples/tree/main/dask/dask_simple.py)
|
| 204 |
+
* [fastai](https://github.com/optuna/optuna-examples/tree/main/fastai/fastai_simple.py)
|
| 205 |
+
* [Keras](https://github.com/optuna/optuna-examples/tree/main/keras/keras_integration.py)
|
| 206 |
+
* [LightGBM](https://github.com/optuna/optuna-examples/tree/main/lightgbm/lightgbm_integration.py)
|
| 207 |
+
* [PyTorch](https://github.com/optuna/optuna-examples/tree/main/pytorch/pytorch_simple.py)
|
| 208 |
+
* [PyTorch Ignite](https://github.com/optuna/optuna-examples/tree/main/pytorch/pytorch_ignite_simple.py)
|
| 209 |
+
* [PyTorch Lightning](https://github.com/optuna/optuna-examples/tree/main/pytorch/pytorch_lightning_simple.py)
|
| 210 |
+
* [TensorFlow](https://github.com/optuna/optuna-examples/tree/main/tensorflow/tensorflow_estimator_integration.py)
|
| 211 |
+
* [tf.keras](https://github.com/optuna/optuna-examples/tree/main/tfkeras/tfkeras_integration.py)
|
| 212 |
+
* [XGBoost](https://github.com/optuna/optuna-examples/tree/main/xgboost/xgboost_integration.py)
|
| 213 |
+
</details>
|
| 214 |
+
|
| 215 |
+
## Web Dashboard
|
| 216 |
+
|
| 217 |
+
[Optuna Dashboard](https://github.com/optuna/optuna-dashboard) is a real-time web dashboard for Optuna.
|
| 218 |
+
You can check the optimization history, hyperparameter importance, etc. in graphs and tables.
|
| 219 |
+
You don't need to create a Python script to call [Optuna's visualization](https://optuna.readthedocs.io/en/stable/reference/visualization/index.html) functions.
|
| 220 |
+
Feature requests and bug reports are welcome!
|
| 221 |
+
|
| 222 |
+

|
| 223 |
+
|
| 224 |
+
`optuna-dashboard` can be installed via pip:
|
| 225 |
+
|
| 226 |
+
```shell
|
| 227 |
+
$ pip install optuna-dashboard
|
| 228 |
+
```
|
| 229 |
+
|
| 230 |
+
> [!TIP]
|
| 231 |
+
> Please check out the convenience of Optuna Dashboard using the sample code below.
|
| 232 |
+
|
| 233 |
+
<details>
|
| 234 |
+
<summary>Sample code to launch Optuna Dashboard</summary>
|
| 235 |
+
|
| 236 |
+
Save the following code as `optimize_toy.py`.
|
| 237 |
+
|
| 238 |
+
```python
|
| 239 |
+
import optuna
|
| 240 |
+
|
| 241 |
+
|
| 242 |
+
def objective(trial):
|
| 243 |
+
x1 = trial.suggest_float("x1", -100, 100)
|
| 244 |
+
x2 = trial.suggest_float("x2", -100, 100)
|
| 245 |
+
return x1**2 + 0.01 * x2**2
|
| 246 |
+
|
| 247 |
+
|
| 248 |
+
study = optuna.create_study(storage="sqlite:///db.sqlite3") # Create a new study with database.
|
| 249 |
+
study.optimize(objective, n_trials=100)
|
| 250 |
+
```
|
| 251 |
+
|
| 252 |
+
Then try the commands below:
|
| 253 |
+
|
| 254 |
+
```shell
|
| 255 |
+
# Run the study specified above
|
| 256 |
+
$ python optimize_toy.py
|
| 257 |
+
|
| 258 |
+
# Launch the dashboard based on the storage `sqlite:///db.sqlite3`
|
| 259 |
+
$ optuna-dashboard sqlite:///db.sqlite3
|
| 260 |
+
...
|
| 261 |
+
Listening on http://localhost:8080/
|
| 262 |
+
Hit Ctrl-C to quit.
|
| 263 |
+
```
|
| 264 |
+
|
| 265 |
+
</details>
|
| 266 |
+
|
| 267 |
+
|
| 268 |
+
## OptunaHub
|
| 269 |
+
|
| 270 |
+
[OptunaHub](https://hub.optuna.org/) is a feature-sharing platform for Optuna.
|
| 271 |
+
You can use the registered features and publish your packages.
|
| 272 |
+
|
| 273 |
+
### Use registered features
|
| 274 |
+
|
| 275 |
+
`optunahub` can be installed via pip:
|
| 276 |
+
|
| 277 |
+
```shell
|
| 278 |
+
$ pip install optunahub
|
| 279 |
+
# Install AutoSampler dependencies (CPU only is sufficient for PyTorch)
|
| 280 |
+
$ pip install cmaes scipy torch --extra-index-url https://download.pytorch.org/whl/cpu
|
| 281 |
+
```
|
| 282 |
+
|
| 283 |
+
You can load registered module with `optunahub.load_module`.
|
| 284 |
+
|
| 285 |
+
```python
|
| 286 |
+
import optuna
|
| 287 |
+
import optunahub
|
| 288 |
+
|
| 289 |
+
|
| 290 |
+
def objective(trial: optuna.Trial) -> float:
|
| 291 |
+
x = trial.suggest_float("x", -5, 5)
|
| 292 |
+
y = trial.suggest_float("y", -5, 5)
|
| 293 |
+
return x**2 + y**2
|
| 294 |
+
|
| 295 |
+
|
| 296 |
+
module = optunahub.load_module(package="samplers/auto_sampler")
|
| 297 |
+
study = optuna.create_study(sampler=module.AutoSampler())
|
| 298 |
+
study.optimize(objective, n_trials=10)
|
| 299 |
+
|
| 300 |
+
print(study.best_trial.value, study.best_trial.params)
|
| 301 |
+
```
|
| 302 |
+
|
| 303 |
+
For more details, please refer to [the optunahub documentation](https://optuna.github.io/optunahub/).
|
| 304 |
+
|
| 305 |
+
### Publish your packages
|
| 306 |
+
|
| 307 |
+
You can publish your package via [optunahub-registry](https://github.com/optuna/optunahub-registry).
|
| 308 |
+
See the [Tutorials for Contributors](https://optuna.github.io/optunahub/tutorials_for_contributors.html) in OptunaHub.
|
| 309 |
+
|
| 310 |
+
|
| 311 |
+
## Communication
|
| 312 |
+
|
| 313 |
+
- [GitHub Discussions] for questions.
|
| 314 |
+
- [GitHub Issues] for bug reports and feature requests.
|
| 315 |
+
|
| 316 |
+
[GitHub Discussions]: https://github.com/optuna/optuna/discussions
|
| 317 |
+
[GitHub issues]: https://github.com/optuna/optuna/issues
|
| 318 |
+
|
| 319 |
+
|
| 320 |
+
## Contribution
|
| 321 |
+
|
| 322 |
+
Any contributions to Optuna are more than welcome!
|
| 323 |
+
|
| 324 |
+
If you are new to Optuna, please check the [good first issues](https://github.com/optuna/optuna/labels/good%20first%20issue). They are relatively simple, well-defined, and often good starting points for you to get familiar with the contribution workflow and other developers.
|
| 325 |
+
|
| 326 |
+
If you already have contributed to Optuna, we recommend the other [contribution-welcome issues](https://github.com/optuna/optuna/labels/contribution-welcome).
|
| 327 |
+
|
| 328 |
+
For general guidelines on how to contribute to the project, take a look at [CONTRIBUTING.md](./CONTRIBUTING.md).
|
| 329 |
+
|
| 330 |
+
|
| 331 |
+
## Reference
|
| 332 |
+
|
| 333 |
+
If you use Optuna in one of your research projects, please cite [our KDD paper](https://doi.org/10.1145/3292500.3330701) "Optuna: A Next-generation Hyperparameter Optimization Framework":
|
| 334 |
+
|
| 335 |
+
<details open>
|
| 336 |
+
<summary>BibTeX</summary>
|
| 337 |
+
|
| 338 |
+
```bibtex
|
| 339 |
+
@inproceedings{akiba2019optuna,
|
| 340 |
+
title={{O}ptuna: A Next-Generation Hyperparameter Optimization Framework},
|
| 341 |
+
author={Akiba, Takuya and Sano, Shotaro and Yanase, Toshihiko and Ohta, Takeru and Koyama, Masanori},
|
| 342 |
+
booktitle={The 25th ACM SIGKDD International Conference on Knowledge Discovery \& Data Mining},
|
| 343 |
+
pages={2623--2631},
|
| 344 |
+
year={2019}
|
| 345 |
+
}
|
| 346 |
+
```
|
| 347 |
+
</details>
|
| 348 |
+
|
| 349 |
+
|
| 350 |
+
## License
|
| 351 |
+
|
| 352 |
+
MIT License (see [LICENSE](./LICENSE)).
|
| 353 |
+
|
| 354 |
+
Optuna uses the codes from SciPy and fdlibm projects (see [LICENSE_THIRD_PARTY](./LICENSE_THIRD_PARTY)).
|
.cache/pip/http-v2/3/3/2/7/a/3327a46f678846be6cb46f3352e6fba668d9664c70a79484c770e358
ADDED
|
Binary file (1.23 kB). View file
|
|
|
.cache/pip/http-v2/3/4/a/c/e/34ace27b9fbcfbe3592fe5b9ea07a848064781b37e129803e4325770
ADDED
|
Binary file (1.24 kB). View file
|
|
|
.cache/pip/http-v2/3/4/a/c/e/34ace27b9fbcfbe3592fe5b9ea07a848064781b37e129803e4325770.body
ADDED
|
@@ -0,0 +1,1600 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Metadata-Version: 2.4
|
| 2 |
+
Name: tqdm
|
| 3 |
+
Version: 4.68.4
|
| 4 |
+
Summary: Fast, Extensible Progress Meter
|
| 5 |
+
Maintainer-email: tqdm developers <devs@tqdm.ml>
|
| 6 |
+
License: MPL-2.0 AND MIT
|
| 7 |
+
Project-URL: homepage, https://tqdm.github.io
|
| 8 |
+
Project-URL: repository, https://github.com/tqdm/tqdm
|
| 9 |
+
Project-URL: changelog, https://tqdm.github.io/releases
|
| 10 |
+
Project-URL: wiki, https://github.com/tqdm/tqdm/wiki
|
| 11 |
+
Keywords: progressbar,progressmeter,progress,bar,meter,rate,eta,console,terminal,time
|
| 12 |
+
Classifier: Development Status :: 5 - Production/Stable
|
| 13 |
+
Classifier: Environment :: Console
|
| 14 |
+
Classifier: Environment :: MacOS X
|
| 15 |
+
Classifier: Environment :: Other Environment
|
| 16 |
+
Classifier: Environment :: Win32 (MS Windows)
|
| 17 |
+
Classifier: Environment :: X11 Applications
|
| 18 |
+
Classifier: Framework :: IPython
|
| 19 |
+
Classifier: Framework :: Jupyter
|
| 20 |
+
Classifier: Intended Audience :: Developers
|
| 21 |
+
Classifier: Intended Audience :: Education
|
| 22 |
+
Classifier: Intended Audience :: End Users/Desktop
|
| 23 |
+
Classifier: Intended Audience :: Other Audience
|
| 24 |
+
Classifier: Intended Audience :: System Administrators
|
| 25 |
+
Classifier: Operating System :: MacOS
|
| 26 |
+
Classifier: Operating System :: MacOS :: MacOS X
|
| 27 |
+
Classifier: Operating System :: Microsoft
|
| 28 |
+
Classifier: Operating System :: Microsoft :: MS-DOS
|
| 29 |
+
Classifier: Operating System :: Microsoft :: Windows
|
| 30 |
+
Classifier: Operating System :: POSIX
|
| 31 |
+
Classifier: Operating System :: POSIX :: BSD
|
| 32 |
+
Classifier: Operating System :: POSIX :: BSD :: FreeBSD
|
| 33 |
+
Classifier: Operating System :: POSIX :: Linux
|
| 34 |
+
Classifier: Operating System :: POSIX :: SunOS/Solaris
|
| 35 |
+
Classifier: Operating System :: Unix
|
| 36 |
+
Classifier: Programming Language :: Python
|
| 37 |
+
Classifier: Programming Language :: Python :: 3
|
| 38 |
+
Classifier: Programming Language :: Python :: 3.8
|
| 39 |
+
Classifier: Programming Language :: Python :: 3.9
|
| 40 |
+
Classifier: Programming Language :: Python :: 3.10
|
| 41 |
+
Classifier: Programming Language :: Python :: 3.11
|
| 42 |
+
Classifier: Programming Language :: Python :: 3.12
|
| 43 |
+
Classifier: Programming Language :: Python :: 3.13
|
| 44 |
+
Classifier: Programming Language :: Python :: 3.14
|
| 45 |
+
Classifier: Programming Language :: Python :: 3 :: Only
|
| 46 |
+
Classifier: Programming Language :: Python :: Implementation
|
| 47 |
+
Classifier: Programming Language :: Python :: Implementation :: IronPython
|
| 48 |
+
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
| 49 |
+
Classifier: Programming Language :: Unix Shell
|
| 50 |
+
Classifier: Topic :: Desktop Environment
|
| 51 |
+
Classifier: Topic :: Education :: Computer Aided Instruction (CAI)
|
| 52 |
+
Classifier: Topic :: Education :: Testing
|
| 53 |
+
Classifier: Topic :: Office/Business
|
| 54 |
+
Classifier: Topic :: Other/Nonlisted Topic
|
| 55 |
+
Classifier: Topic :: Software Development :: Build Tools
|
| 56 |
+
Classifier: Topic :: Software Development :: Libraries
|
| 57 |
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
| 58 |
+
Classifier: Topic :: Software Development :: Pre-processors
|
| 59 |
+
Classifier: Topic :: Software Development :: User Interfaces
|
| 60 |
+
Classifier: Topic :: System :: Installation/Setup
|
| 61 |
+
Classifier: Topic :: System :: Logging
|
| 62 |
+
Classifier: Topic :: System :: Monitoring
|
| 63 |
+
Classifier: Topic :: System :: Shells
|
| 64 |
+
Classifier: Topic :: Terminals
|
| 65 |
+
Classifier: Topic :: Utilities
|
| 66 |
+
Requires-Python: >=3.8
|
| 67 |
+
Description-Content-Type: text/x-rst
|
| 68 |
+
License-File: LICENCE
|
| 69 |
+
Requires-Dist: colorama; platform_system == "Windows"
|
| 70 |
+
Provides-Extra: discord
|
| 71 |
+
Requires-Dist: requests; extra == "discord"
|
| 72 |
+
Requires-Dist: envwrap; extra == "discord"
|
| 73 |
+
Provides-Extra: slack
|
| 74 |
+
Requires-Dist: slack-sdk; extra == "slack"
|
| 75 |
+
Requires-Dist: envwrap; extra == "slack"
|
| 76 |
+
Provides-Extra: telegram
|
| 77 |
+
Requires-Dist: requests; extra == "telegram"
|
| 78 |
+
Requires-Dist: envwrap; extra == "telegram"
|
| 79 |
+
Provides-Extra: notebook
|
| 80 |
+
Requires-Dist: ipywidgets>=6; extra == "notebook"
|
| 81 |
+
Dynamic: license-file
|
| 82 |
+
|
| 83 |
+
|Logo|
|
| 84 |
+
|
| 85 |
+
tqdm
|
| 86 |
+
====
|
| 87 |
+
|
| 88 |
+
|Py-Versions| |Versions| |Conda-Forge-Status| |Docker| |Snapcraft|
|
| 89 |
+
|
| 90 |
+
|Build-Status| |Coverage-Status| |Branch-Coverage-Status| |Codacy-Grade| |Libraries-Rank| |PyPI-Downloads|
|
| 91 |
+
|
| 92 |
+
|LICENCE| |OpenHub-Status| |colab-demo| |binder-demo| |awesome-python|
|
| 93 |
+
|
| 94 |
+
``tqdm`` derives from the Arabic word *taqaddum* (تقدّم) which can mean "progress,"
|
| 95 |
+
and is an abbreviation for "I love you so much" in Spanish (*te quiero demasiado*).
|
| 96 |
+
|
| 97 |
+
Instantly make your loops show a smart progress meter - just wrap any
|
| 98 |
+
iterable with ``tqdm(iterable)``, and you're done!
|
| 99 |
+
|
| 100 |
+
.. code:: python
|
| 101 |
+
|
| 102 |
+
from tqdm import tqdm
|
| 103 |
+
for i in tqdm(range(10000)):
|
| 104 |
+
...
|
| 105 |
+
|
| 106 |
+
``76%|████████████████████████ | 7568/10000 [00:33<00:10, 229.00it/s]``
|
| 107 |
+
|
| 108 |
+
``trange(N)`` can be also used as a convenient shortcut for
|
| 109 |
+
``tqdm(range(N))``.
|
| 110 |
+
|
| 111 |
+
|Screenshot|
|
| 112 |
+
|Video| |Slides| |Merch|
|
| 113 |
+
|
| 114 |
+
It can also be executed as a module with pipes:
|
| 115 |
+
|
| 116 |
+
.. code:: sh
|
| 117 |
+
|
| 118 |
+
$ seq 9999999 | tqdm --bytes | wc -l
|
| 119 |
+
75.2MB [00:00, 217MB/s]
|
| 120 |
+
9999999
|
| 121 |
+
|
| 122 |
+
$ tar -zcf - docs/ | tqdm --bytes --total `du -sb docs/ | cut -f1` \
|
| 123 |
+
> backup.tgz
|
| 124 |
+
32%|██████████▍ | 8.89G/27.9G [00:42<01:31, 223MB/s]
|
| 125 |
+
|
| 126 |
+
Overhead is low -- about 60ns per iteration (80ns with ``tqdm.gui``), and is
|
| 127 |
+
unit tested against performance regression.
|
| 128 |
+
By comparison, the well-established
|
| 129 |
+
`ProgressBar <https://github.com/niltonvolpato/python-progressbar>`__ has
|
| 130 |
+
an 800ns/iter overhead.
|
| 131 |
+
|
| 132 |
+
In addition to its low overhead, ``tqdm`` uses smart algorithms to predict
|
| 133 |
+
the remaining time and to skip unnecessary iteration displays, which allows
|
| 134 |
+
for a negligible overhead in most cases.
|
| 135 |
+
|
| 136 |
+
``tqdm`` works on any platform
|
| 137 |
+
(Linux, Windows, Mac, FreeBSD, NetBSD, Solaris/SunOS),
|
| 138 |
+
in any console or in a GUI, and is also friendly with IPython/Jupyter notebooks.
|
| 139 |
+
|
| 140 |
+
``tqdm`` does not require any dependencies (not even ``curses``!), just
|
| 141 |
+
Python and an environment supporting ``carriage return \r`` and
|
| 142 |
+
``line feed \n`` control characters.
|
| 143 |
+
|
| 144 |
+
**Featured Sponsors**
|
| 145 |
+
|
| 146 |
+
======== ================================================
|
| 147 |
+
|OpenAI| Your Logo Here
|
| 148 |
+
======== ================================================
|
| 149 |
+
OpenAI `Sponsors <https://github.com/sponsors/tqdm>`__
|
| 150 |
+
======== ================================================
|
| 151 |
+
|
| 152 |
+
.. |OpenAI| image:: https://avatars.githubusercontent.com/u/14957082?s=96
|
| 153 |
+
:target: https://openai.com
|
| 154 |
+
|
| 155 |
+
------------------------------------------
|
| 156 |
+
|
| 157 |
+
.. contents:: Table of contents
|
| 158 |
+
:backlinks: top
|
| 159 |
+
:local:
|
| 160 |
+
|
| 161 |
+
|
| 162 |
+
Installation
|
| 163 |
+
------------
|
| 164 |
+
|
| 165 |
+
Latest PyPI stable release
|
| 166 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 167 |
+
|
| 168 |
+
|Versions| |PyPI-Downloads| |Libraries-Dependents|
|
| 169 |
+
|
| 170 |
+
.. code:: sh
|
| 171 |
+
|
| 172 |
+
pip install tqdm
|
| 173 |
+
|
| 174 |
+
Latest development release on GitHub
|
| 175 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 176 |
+
|
| 177 |
+
|GitHub-Status| |GitHub-Stars| |GitHub-Commits| |GitHub-Forks| |GitHub-Updated|
|
| 178 |
+
|
| 179 |
+
Pull and install pre-release ``devel`` branch:
|
| 180 |
+
|
| 181 |
+
.. code:: sh
|
| 182 |
+
|
| 183 |
+
pip install "git+https://github.com/tqdm/tqdm.git@devel#egg=tqdm"
|
| 184 |
+
|
| 185 |
+
Latest Conda release
|
| 186 |
+
~~~~~~~~~~~~~~~~~~~~
|
| 187 |
+
|
| 188 |
+
|Conda-Forge-Status|
|
| 189 |
+
|
| 190 |
+
.. code:: sh
|
| 191 |
+
|
| 192 |
+
conda install -c conda-forge tqdm
|
| 193 |
+
|
| 194 |
+
Latest Snapcraft release
|
| 195 |
+
~~~~~~~~~~~~~~~~~~~~~~~~
|
| 196 |
+
|
| 197 |
+
|Snapcraft|
|
| 198 |
+
|
| 199 |
+
There are 3 channels to choose from:
|
| 200 |
+
|
| 201 |
+
.. code:: sh
|
| 202 |
+
|
| 203 |
+
snap install tqdm # implies --stable, i.e. latest tagged release
|
| 204 |
+
snap install tqdm --candidate # master branch
|
| 205 |
+
snap install tqdm --edge # devel branch
|
| 206 |
+
|
| 207 |
+
Note that ``snap`` binaries are purely for CLI use (not ``import``-able), and
|
| 208 |
+
automatically set up ``bash`` tab-completion.
|
| 209 |
+
|
| 210 |
+
Latest Docker release
|
| 211 |
+
~~~~~~~~~~~~~~~~~~~~~
|
| 212 |
+
|
| 213 |
+
|Docker|
|
| 214 |
+
|
| 215 |
+
.. code:: sh
|
| 216 |
+
|
| 217 |
+
docker pull tqdm/tqdm
|
| 218 |
+
docker run -i --rm tqdm/tqdm --help
|
| 219 |
+
|
| 220 |
+
Other
|
| 221 |
+
~~~~~
|
| 222 |
+
|
| 223 |
+
There are other (unofficial) places where ``tqdm`` may be downloaded, particularly for CLI use:
|
| 224 |
+
|
| 225 |
+
|Repology|
|
| 226 |
+
|
| 227 |
+
.. |Repology| image:: https://repology.org/badge/tiny-repos/python:tqdm.svg
|
| 228 |
+
:target: https://repology.org/project/python:tqdm/versions
|
| 229 |
+
|
| 230 |
+
Changelog
|
| 231 |
+
---------
|
| 232 |
+
|
| 233 |
+
The list of all changes is available either on GitHub's Releases:
|
| 234 |
+
|GitHub-Status|, on the
|
| 235 |
+
`wiki <https://github.com/tqdm/tqdm/wiki/Releases>`__, or on the
|
| 236 |
+
`website <https://tqdm.github.io/releases>`__.
|
| 237 |
+
|
| 238 |
+
|
| 239 |
+
Usage
|
| 240 |
+
-----
|
| 241 |
+
|
| 242 |
+
``tqdm`` is very versatile and can be used in a number of ways.
|
| 243 |
+
The three main ones are given below.
|
| 244 |
+
|
| 245 |
+
Iterable-based
|
| 246 |
+
~~~~~~~~~~~~~~
|
| 247 |
+
|
| 248 |
+
Wrap ``tqdm()`` around any iterable:
|
| 249 |
+
|
| 250 |
+
.. code:: python
|
| 251 |
+
|
| 252 |
+
from tqdm import tqdm
|
| 253 |
+
from time import sleep
|
| 254 |
+
|
| 255 |
+
text = ""
|
| 256 |
+
for char in tqdm(["a", "b", "c", "d"]):
|
| 257 |
+
sleep(0.25)
|
| 258 |
+
text = text + char
|
| 259 |
+
|
| 260 |
+
``trange(i)`` is a special optimised instance of ``tqdm(range(i))``:
|
| 261 |
+
|
| 262 |
+
.. code:: python
|
| 263 |
+
|
| 264 |
+
from tqdm import trange
|
| 265 |
+
|
| 266 |
+
for i in trange(100):
|
| 267 |
+
sleep(0.01)
|
| 268 |
+
|
| 269 |
+
Instantiation outside of the loop allows for manual control over ``tqdm()``:
|
| 270 |
+
|
| 271 |
+
.. code:: python
|
| 272 |
+
|
| 273 |
+
pbar = tqdm(["a", "b", "c", "d"])
|
| 274 |
+
for char in pbar:
|
| 275 |
+
sleep(0.25)
|
| 276 |
+
pbar.set_description("Processing %s" % char)
|
| 277 |
+
|
| 278 |
+
Manual
|
| 279 |
+
~~~~~~
|
| 280 |
+
|
| 281 |
+
Manual control of ``tqdm()`` updates using a ``with`` statement:
|
| 282 |
+
|
| 283 |
+
.. code:: python
|
| 284 |
+
|
| 285 |
+
with tqdm(total=100) as pbar:
|
| 286 |
+
for i in range(10):
|
| 287 |
+
sleep(0.1)
|
| 288 |
+
pbar.update(10)
|
| 289 |
+
|
| 290 |
+
If the optional variable ``total`` (or an iterable with ``len()``) is
|
| 291 |
+
provided, predictive stats are displayed.
|
| 292 |
+
|
| 293 |
+
``with`` is also optional (you can just assign ``tqdm()`` to a variable,
|
| 294 |
+
but in this case don't forget to ``del`` or ``close()`` at the end:
|
| 295 |
+
|
| 296 |
+
.. code:: python
|
| 297 |
+
|
| 298 |
+
pbar = tqdm(total=100)
|
| 299 |
+
for i in range(10):
|
| 300 |
+
sleep(0.1)
|
| 301 |
+
pbar.update(10)
|
| 302 |
+
pbar.close()
|
| 303 |
+
|
| 304 |
+
Module
|
| 305 |
+
~~~~~~
|
| 306 |
+
|
| 307 |
+
Perhaps the most wonderful use of ``tqdm`` is in a script or on the command
|
| 308 |
+
line. Simply inserting ``tqdm`` (or ``python -m tqdm``) between pipes will pass
|
| 309 |
+
through all ``stdin`` to ``stdout`` while printing progress to ``stderr``.
|
| 310 |
+
|
| 311 |
+
The example below demonstrate counting the number of lines in all Python files
|
| 312 |
+
in the current directory, with timing information included.
|
| 313 |
+
|
| 314 |
+
.. code:: sh
|
| 315 |
+
|
| 316 |
+
$ time find . -name '*.py' -type f -exec cat \{} \; | wc -l
|
| 317 |
+
857365
|
| 318 |
+
|
| 319 |
+
real 0m3.458s
|
| 320 |
+
user 0m0.274s
|
| 321 |
+
sys 0m3.325s
|
| 322 |
+
|
| 323 |
+
$ time find . -name '*.py' -type f -exec cat \{} \; | tqdm | wc -l
|
| 324 |
+
857366it [00:03, 246471.31it/s]
|
| 325 |
+
857365
|
| 326 |
+
|
| 327 |
+
real 0m3.585s
|
| 328 |
+
user 0m0.862s
|
| 329 |
+
sys 0m3.358s
|
| 330 |
+
|
| 331 |
+
Note that the usual arguments for ``tqdm`` can also be specified.
|
| 332 |
+
|
| 333 |
+
.. code:: sh
|
| 334 |
+
|
| 335 |
+
$ find . -name '*.py' -type f -exec cat \{} \; |
|
| 336 |
+
tqdm --unit loc --unit_scale --total 857366 >> /dev/null
|
| 337 |
+
100%|█████████████████████████████████| 857K/857K [00:04<00:00, 246Kloc/s]
|
| 338 |
+
|
| 339 |
+
Backing up a large directory?
|
| 340 |
+
|
| 341 |
+
.. code:: sh
|
| 342 |
+
|
| 343 |
+
$ tar -zcf - docs/ | tqdm --bytes --total `du -sb docs/ | cut -f1` \
|
| 344 |
+
> backup.tgz
|
| 345 |
+
44%|██████████████▊ | 153M/352M [00:14<00:18, 11.0MB/s]
|
| 346 |
+
|
| 347 |
+
This can be beautified further:
|
| 348 |
+
|
| 349 |
+
.. code:: sh
|
| 350 |
+
|
| 351 |
+
$ BYTES=$(du -sb docs/ | cut -f1)
|
| 352 |
+
$ tar -cf - docs/ \
|
| 353 |
+
| tqdm --bytes --total "$BYTES" --desc Processing | gzip \
|
| 354 |
+
| tqdm --bytes --total "$BYTES" --desc Compressed --position 1 \
|
| 355 |
+
> ~/backup.tgz
|
| 356 |
+
Processing: 100%|██████████████████████| 352M/352M [00:14<00:00, 30.2MB/s]
|
| 357 |
+
Compressed: 42%|█████████▎ | 148M/352M [00:14<00:19, 10.9MB/s]
|
| 358 |
+
|
| 359 |
+
Or done on a file level using 7-zip:
|
| 360 |
+
|
| 361 |
+
.. code:: sh
|
| 362 |
+
|
| 363 |
+
$ 7z a -bd -r backup.7z docs/ | grep Compressing \
|
| 364 |
+
| tqdm --total $(find docs/ -type f | wc -l) --unit files \
|
| 365 |
+
| grep -v Compressing
|
| 366 |
+
100%|██████████████████████████▉| 15327/15327 [01:00<00:00, 712.96files/s]
|
| 367 |
+
|
| 368 |
+
Pre-existing CLI programs already outputting basic progress information will
|
| 369 |
+
benefit from ``tqdm``'s ``--update`` and ``--update_to`` flags:
|
| 370 |
+
|
| 371 |
+
.. code:: sh
|
| 372 |
+
|
| 373 |
+
$ seq 3 0.1 5 | tqdm --total 5 --update_to --null
|
| 374 |
+
100%|████████████████████████████████████| 5.0/5 [00:00<00:00, 9673.21it/s]
|
| 375 |
+
$ seq 10 | tqdm --update --null # 1 + 2 + ... + 10 = 55 iterations
|
| 376 |
+
55it [00:00, 90006.52it/s]
|
| 377 |
+
|
| 378 |
+
FAQ and Known Issues
|
| 379 |
+
--------------------
|
| 380 |
+
|
| 381 |
+
|GitHub-Issues|
|
| 382 |
+
|
| 383 |
+
The most common issues relate to excessive output on multiple lines, instead
|
| 384 |
+
of a neat one-line progress bar.
|
| 385 |
+
|
| 386 |
+
- Consoles in general: require support for carriage return (``CR``, ``\r``).
|
| 387 |
+
|
| 388 |
+
* Some cloud logging consoles which don't support ``\r`` properly
|
| 389 |
+
(`cloudwatch <https://github.com/tqdm/tqdm/issues/966>`__,
|
| 390 |
+
`K8s <https://github.com/tqdm/tqdm/issues/1319>`__) may benefit from
|
| 391 |
+
``export TQDM_POSITION=-1``.
|
| 392 |
+
|
| 393 |
+
- Nested progress bars:
|
| 394 |
+
|
| 395 |
+
* Consoles in general: require support for moving cursors up to the
|
| 396 |
+
previous line. For example,
|
| 397 |
+
`IDLE <https://github.com/tqdm/tqdm/issues/191#issuecomment-230168030>`__,
|
| 398 |
+
`ConEmu <https://github.com/tqdm/tqdm/issues/254>`__ and
|
| 399 |
+
`PyCharm <https://github.com/tqdm/tqdm/issues/203>`__ (also
|
| 400 |
+
`here <https://github.com/tqdm/tqdm/issues/208>`__,
|
| 401 |
+
`here <https://github.com/tqdm/tqdm/issues/307>`__, and
|
| 402 |
+
`here <https://github.com/tqdm/tqdm/issues/454#issuecomment-335416815>`__)
|
| 403 |
+
lack full support.
|
| 404 |
+
* Windows: additionally may require the Python module ``colorama``
|
| 405 |
+
to ensure nested bars stay within their respective lines.
|
| 406 |
+
|
| 407 |
+
- Unicode:
|
| 408 |
+
|
| 409 |
+
* Environments which report that they support unicode will have solid smooth
|
| 410 |
+
progress bars. The fallback is an ``ascii``-only bar.
|
| 411 |
+
* Windows consoles often only partially support unicode and thus
|
| 412 |
+
`often require explicit ascii=True <https://github.com/tqdm/tqdm/issues/454#issuecomment-335416815>`__
|
| 413 |
+
(also `here <https://github.com/tqdm/tqdm/issues/499>`__). This is due to
|
| 414 |
+
either normal-width unicode characters being incorrectly displayed as
|
| 415 |
+
"wide", or some unicode characters not rendering.
|
| 416 |
+
|
| 417 |
+
- Wrapping generators:
|
| 418 |
+
|
| 419 |
+
* Generator wrapper functions tend to hide the length of iterables.
|
| 420 |
+
``tqdm`` does not.
|
| 421 |
+
* Replace ``tqdm(enumerate(...))`` with ``enumerate(tqdm(...))`` or
|
| 422 |
+
``tqdm(enumerate(x), total=len(x), ...)``.
|
| 423 |
+
The same applies to ``numpy.ndenumerate``.
|
| 424 |
+
* Replace ``tqdm(zip(a, b))`` with ``zip(tqdm(a), b)`` or even
|
| 425 |
+
``zip(tqdm(a), tqdm(b))``.
|
| 426 |
+
* The same applies to ``itertools``.
|
| 427 |
+
* Some useful convenience functions can be found under ``tqdm.contrib``.
|
| 428 |
+
|
| 429 |
+
- `No intermediate output in docker-compose <https://github.com/tqdm/tqdm/issues/771>`__:
|
| 430 |
+
use ``docker-compose run`` instead of ``docker-compose up`` and ``tty: true``.
|
| 431 |
+
|
| 432 |
+
- Overriding defaults via environment variables:
|
| 433 |
+
e.g. in CI/cloud jobs, ``export TQDM_MININTERVAL=5`` to avoid log spam.
|
| 434 |
+
This override logic is handled by the ``tqdm.utils.envwrap`` decorator
|
| 435 |
+
(useful independent of ``tqdm``).
|
| 436 |
+
|
| 437 |
+
If you come across any other difficulties, browse and file |GitHub-Issues|.
|
| 438 |
+
|
| 439 |
+
Documentation
|
| 440 |
+
-------------
|
| 441 |
+
|
| 442 |
+
|Py-Versions| |README-Hits| (Since 19 May 2016)
|
| 443 |
+
|
| 444 |
+
.. code:: python
|
| 445 |
+
|
| 446 |
+
class tqdm():
|
| 447 |
+
"""
|
| 448 |
+
Decorate an iterable object, returning an iterator which acts exactly
|
| 449 |
+
like the original iterable, but prints a dynamically updating
|
| 450 |
+
progress bar every time a value is requested.
|
| 451 |
+
"""
|
| 452 |
+
|
| 453 |
+
@envwrap("tqdm") # override defaults via env vars
|
| 454 |
+
def __init__(self, iterable=None, desc=None, total=None, leave=True,
|
| 455 |
+
file=None, ncols=None, mininterval=0.1,
|
| 456 |
+
maxinterval=10.0, miniters=None, ascii=None, disable=False,
|
| 457 |
+
unit='it', unit_scale=False, dynamic_ncols=False,
|
| 458 |
+
smoothing=0.3, bar_format=None, initial=0, position=None,
|
| 459 |
+
postfix=None, unit_divisor=1000, write_bytes=False,
|
| 460 |
+
lock_args=None, nrows=None, colour=None, delay=0):
|
| 461 |
+
|
| 462 |
+
Parameters
|
| 463 |
+
~~~~~~~~~~
|
| 464 |
+
|
| 465 |
+
* iterable : iterable, optional
|
| 466 |
+
Iterable to decorate with a progress bar.
|
| 467 |
+
Leave blank to manually manage the updates.
|
| 468 |
+
* desc : str, optional
|
| 469 |
+
Prefix for the progress bar.
|
| 470 |
+
* total : int or float, optional
|
| 471 |
+
The number of expected iterations. If unspecified,
|
| 472 |
+
len(iterable) is used if possible. If float("inf") or as a last
|
| 473 |
+
resort, only basic progress statistics are displayed
|
| 474 |
+
(no ETA, no progress bar).
|
| 475 |
+
If ``gui`` is True and this parameter needs subsequent updating,
|
| 476 |
+
specify an initial arbitrary large positive number,
|
| 477 |
+
e.g. 9e9.
|
| 478 |
+
* leave : bool, optional
|
| 479 |
+
If [default: True], keeps all traces of the progress bar
|
| 480 |
+
upon termination of iteration.
|
| 481 |
+
If ``None``, will leave only if ``position`` is ``0``.
|
| 482 |
+
* file : ``io.TextIOWrapper`` or ``io.StringIO``, optional
|
| 483 |
+
Specifies where to output the progress messages
|
| 484 |
+
(default: sys.stderr). Uses ``file.write(str)`` and ``file.flush()``
|
| 485 |
+
methods. For encoding, see ``write_bytes``.
|
| 486 |
+
* ncols : int, optional
|
| 487 |
+
The width of the entire output message. If specified,
|
| 488 |
+
dynamically resizes the progress bar to stay within this bound.
|
| 489 |
+
If unspecified, attempts to use environment width. The
|
| 490 |
+
fallback is a meter width of 10 and no limit for the counter and
|
| 491 |
+
statistics. If 0, will not print any meter (only stats).
|
| 492 |
+
* mininterval : float, optional
|
| 493 |
+
Minimum progress display update interval [default: 0.1] seconds.
|
| 494 |
+
* maxinterval : float, optional
|
| 495 |
+
Maximum progress display update interval [default: 10] seconds.
|
| 496 |
+
Automatically adjusts ``miniters`` to correspond to ``mininterval``
|
| 497 |
+
after long display update lag. Only works if ``dynamic_miniters``
|
| 498 |
+
or monitor thread is enabled.
|
| 499 |
+
* miniters : int or float, optional
|
| 500 |
+
Minimum progress display update interval, in iterations.
|
| 501 |
+
If 0 and ``dynamic_miniters``, will automatically adjust to equal
|
| 502 |
+
``mininterval`` (more CPU efficient, good for tight loops).
|
| 503 |
+
If > 0, will skip display of specified number of iterations.
|
| 504 |
+
Tweak this and ``mininterval`` to get very efficient loops.
|
| 505 |
+
If your progress is erratic with both fast and slow iterations
|
| 506 |
+
(network, skipping items, etc) you should set miniters=1.
|
| 507 |
+
* ascii : bool or str, optional
|
| 508 |
+
If unspecified or False, use unicode (smooth blocks) to fill
|
| 509 |
+
the meter. The fallback is to use ASCII characters " 123456789#".
|
| 510 |
+
* disable : bool, optional
|
| 511 |
+
Whether to disable the entire progress bar wrapper
|
| 512 |
+
[default: False]. If set to None, disable on non-TTY.
|
| 513 |
+
* unit : str, optional
|
| 514 |
+
String that will be used to define the unit of each iteration
|
| 515 |
+
[default: it].
|
| 516 |
+
* unit_scale : bool or int or float, optional
|
| 517 |
+
If 1 or True, the number of iterations will be reduced/scaled
|
| 518 |
+
automatically and a metric prefix following the
|
| 519 |
+
International System of Units standard will be added
|
| 520 |
+
(kilo, mega, etc.) [default: False]. If any other non-zero
|
| 521 |
+
number, will scale ``total`` and ``n``.
|
| 522 |
+
* dynamic_ncols : bool, optional
|
| 523 |
+
If set, constantly alters ``ncols`` and ``nrows`` to the
|
| 524 |
+
environment (allowing for window resizes) [default: False].
|
| 525 |
+
* smoothing : float, optional
|
| 526 |
+
Exponential moving average smoothing factor for speed estimates
|
| 527 |
+
(ignored in GUI mode). Ranges from 0 (average speed) to 1
|
| 528 |
+
(current/instantaneous speed) [default: 0.3].
|
| 529 |
+
* bar_format : str, optional
|
| 530 |
+
Specify a custom bar string formatting. May impact performance.
|
| 531 |
+
[default: '{l_bar}{bar}{r_bar}'], where
|
| 532 |
+
l_bar='{desc}: {percentage:3.0f}%|' and
|
| 533 |
+
r_bar='| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, '
|
| 534 |
+
'{rate_fmt}{postfix}]'
|
| 535 |
+
Possible vars: l_bar, bar, r_bar, n, n_fmt, total, total_fmt,
|
| 536 |
+
percentage, elapsed, elapsed_s, ncols, nrows, desc, unit,
|
| 537 |
+
rate, rate_fmt, rate_noinv, rate_noinv_fmt,
|
| 538 |
+
rate_inv, rate_inv_fmt, postfix, unit_divisor,
|
| 539 |
+
remaining, remaining_s, eta.
|
| 540 |
+
Note that a trailing ": " is automatically removed after {desc}
|
| 541 |
+
if the latter is empty.
|
| 542 |
+
* initial : int or float, optional
|
| 543 |
+
The initial counter value. Useful when restarting a progress
|
| 544 |
+
bar [default: 0]. If using float, consider specifying ``{n:.3f}``
|
| 545 |
+
or similar in ``bar_format``, or specifying ``unit_scale``.
|
| 546 |
+
* position : int, optional
|
| 547 |
+
Specify the line offset to print this bar (starting from 0)
|
| 548 |
+
Automatic if unspecified.
|
| 549 |
+
Useful to manage multiple bars at once (eg, from threads).
|
| 550 |
+
* postfix : dict or ``*``, optional
|
| 551 |
+
Specify additional stats to display at the end of the bar.
|
| 552 |
+
Calls ``set_postfix(**postfix)`` if possible (dict).
|
| 553 |
+
* unit_divisor : float, optional
|
| 554 |
+
[default: 1000], ignored unless ``unit_scale`` is True.
|
| 555 |
+
* write_bytes : bool, optional
|
| 556 |
+
Whether to write bytes. If (default: False) will write unicode.
|
| 557 |
+
* lock_args : tuple, optional
|
| 558 |
+
Passed to ``refresh`` for intermediate output
|
| 559 |
+
(initialisation, iterating, and updating).
|
| 560 |
+
* nrows : int, optional
|
| 561 |
+
The screen height. If specified, hides nested bars outside this
|
| 562 |
+
bound. If unspecified, attempts to use environment height.
|
| 563 |
+
The fallback is 20.
|
| 564 |
+
* colour : str, optional
|
| 565 |
+
Bar colour (e.g. 'green', '#00ff00').
|
| 566 |
+
* delay : float, optional
|
| 567 |
+
Don't display until [default: 0] seconds have elapsed.
|
| 568 |
+
|
| 569 |
+
Extra CLI Options
|
| 570 |
+
~~~~~~~~~~~~~~~~~
|
| 571 |
+
|
| 572 |
+
* delim : chr, optional
|
| 573 |
+
Delimiting character [default: '\n']. Use '\0' for null.
|
| 574 |
+
N.B.: on Windows systems, Python converts '\n' to '\r\n'.
|
| 575 |
+
* buf_size : int, optional
|
| 576 |
+
String buffer size in bytes [default: 256]
|
| 577 |
+
used when ``delim`` is specified.
|
| 578 |
+
* bytes : bool, optional
|
| 579 |
+
If true, will count bytes, ignore ``delim``, and default
|
| 580 |
+
``unit_scale`` to True, ``unit_divisor`` to 1024, and ``unit`` to 'B'.
|
| 581 |
+
* tee : bool, optional
|
| 582 |
+
If true, passes ``stdin`` to both ``stderr`` and ``stdout``.
|
| 583 |
+
* update : bool, optional
|
| 584 |
+
If true, will treat input as newly elapsed iterations,
|
| 585 |
+
i.e. numbers to pass to ``update()``. Note that this is slow
|
| 586 |
+
(~2e5 it/s) since every input must be decoded as a number.
|
| 587 |
+
* update_to : bool, optional
|
| 588 |
+
If true, will treat input as total elapsed iterations,
|
| 589 |
+
i.e. numbers to assign to ``self.n``. Note that this is slow
|
| 590 |
+
(~2e5 it/s) since every input must be decoded as a number.
|
| 591 |
+
* null : bool, optional
|
| 592 |
+
If true, will discard input (no stdout).
|
| 593 |
+
* manpath : str, optional
|
| 594 |
+
Directory in which to install tqdm man pages.
|
| 595 |
+
* comppath : str, optional
|
| 596 |
+
Directory in which to place tqdm completion.
|
| 597 |
+
* log : str, optional
|
| 598 |
+
CRITICAL|FATAL|ERROR|WARN(ING)|[default: 'INFO']|DEBUG|NOTSET.
|
| 599 |
+
|
| 600 |
+
Returns
|
| 601 |
+
~~~~~~~
|
| 602 |
+
|
| 603 |
+
* out : decorated iterator.
|
| 604 |
+
|
| 605 |
+
.. code:: python
|
| 606 |
+
|
| 607 |
+
class tqdm():
|
| 608 |
+
def update(self, n=1):
|
| 609 |
+
"""
|
| 610 |
+
Manually update the progress bar, useful for streams
|
| 611 |
+
such as reading files.
|
| 612 |
+
E.g.:
|
| 613 |
+
>>> t = tqdm(total=filesize) # Initialise
|
| 614 |
+
>>> for current_buffer in stream:
|
| 615 |
+
... ...
|
| 616 |
+
... t.update(len(current_buffer))
|
| 617 |
+
>>> t.close()
|
| 618 |
+
The last line is highly recommended, but possibly not necessary if
|
| 619 |
+
`t.update()` will be called in such a way that `filesize` will be
|
| 620 |
+
exactly reached and printed.
|
| 621 |
+
|
| 622 |
+
Parameters
|
| 623 |
+
----------
|
| 624 |
+
n : int or float, optional
|
| 625 |
+
Increment to add to the internal counter of iterations
|
| 626 |
+
[default: 1]. If using float, consider specifying `{n:.3f}`
|
| 627 |
+
or similar in `bar_format`, or specifying `unit_scale`.
|
| 628 |
+
|
| 629 |
+
Returns
|
| 630 |
+
-------
|
| 631 |
+
out : bool or None
|
| 632 |
+
True if a `display()` was triggered.
|
| 633 |
+
"""
|
| 634 |
+
|
| 635 |
+
def close(self):
|
| 636 |
+
"""Cleanup and (if leave=False) close the progress bar."""
|
| 637 |
+
|
| 638 |
+
def clear(self, nomove=False):
|
| 639 |
+
"""Clear current bar display."""
|
| 640 |
+
|
| 641 |
+
def refresh(self):
|
| 642 |
+
"""
|
| 643 |
+
Force refresh the display of this bar.
|
| 644 |
+
|
| 645 |
+
Parameters
|
| 646 |
+
----------
|
| 647 |
+
nolock : bool, optional
|
| 648 |
+
If `True`, does not lock.
|
| 649 |
+
If [default: `False`]: calls `acquire()` on internal lock.
|
| 650 |
+
lock_args : tuple, optional
|
| 651 |
+
Passed to internal lock's `acquire()`.
|
| 652 |
+
If specified, will only `display()` if `acquire()` returns `True`.
|
| 653 |
+
"""
|
| 654 |
+
|
| 655 |
+
def unpause(self):
|
| 656 |
+
"""Restart tqdm timer from last print time."""
|
| 657 |
+
|
| 658 |
+
def reset(self, total=None):
|
| 659 |
+
"""
|
| 660 |
+
Resets to 0 iterations for repeated use.
|
| 661 |
+
|
| 662 |
+
Consider combining with `leave=True`.
|
| 663 |
+
|
| 664 |
+
Parameters
|
| 665 |
+
----------
|
| 666 |
+
total : int or float, optional. Total to use for the new bar.
|
| 667 |
+
"""
|
| 668 |
+
|
| 669 |
+
def set_description(self, desc=None, refresh=True):
|
| 670 |
+
"""
|
| 671 |
+
Set/modify description of the progress bar.
|
| 672 |
+
|
| 673 |
+
Parameters
|
| 674 |
+
----------
|
| 675 |
+
desc : str, optional
|
| 676 |
+
refresh : bool, optional
|
| 677 |
+
Forces refresh [default: True].
|
| 678 |
+
"""
|
| 679 |
+
|
| 680 |
+
def set_postfix(self, ordered_dict=None, refresh=True, **tqdm_kwargs):
|
| 681 |
+
"""
|
| 682 |
+
Set/modify postfix (additional stats)
|
| 683 |
+
with automatic formatting based on datatype.
|
| 684 |
+
|
| 685 |
+
Parameters
|
| 686 |
+
----------
|
| 687 |
+
ordered_dict : dict or OrderedDict, optional
|
| 688 |
+
refresh : bool, optional
|
| 689 |
+
Forces refresh [default: True].
|
| 690 |
+
kwargs : dict, optional
|
| 691 |
+
"""
|
| 692 |
+
|
| 693 |
+
@classmethod
|
| 694 |
+
def write(cls, s, file=sys.stdout, end="\n"):
|
| 695 |
+
"""Print a message via tqdm (without overlap with bars)."""
|
| 696 |
+
|
| 697 |
+
@property
|
| 698 |
+
def format_dict(self):
|
| 699 |
+
"""Public API for read-only member access."""
|
| 700 |
+
|
| 701 |
+
def display(self, msg=None, pos=None):
|
| 702 |
+
"""
|
| 703 |
+
Use `self.sp` to display `msg` in the specified `pos`.
|
| 704 |
+
|
| 705 |
+
Consider overloading this function when inheriting to use e.g.:
|
| 706 |
+
`self.some_frontend(**self.format_dict)` instead of `self.sp`.
|
| 707 |
+
|
| 708 |
+
Parameters
|
| 709 |
+
----------
|
| 710 |
+
msg : str, optional. What to display (default: `repr(self)`).
|
| 711 |
+
pos : int, optional. Position to `moveto`
|
| 712 |
+
(default: `abs(self.pos)`).
|
| 713 |
+
"""
|
| 714 |
+
|
| 715 |
+
@classmethod
|
| 716 |
+
@contextmanager
|
| 717 |
+
def wrapattr(cls, stream, method, total=None, bytes=True, **tqdm_kwargs):
|
| 718 |
+
"""
|
| 719 |
+
stream : file-like object.
|
| 720 |
+
method : str, "read" or "write". The result of `read()` and
|
| 721 |
+
the first argument of `write()` should have a `len()`.
|
| 722 |
+
|
| 723 |
+
>>> with tqdm.wrapattr(file_obj, "read", total=file_obj.size) as fobj:
|
| 724 |
+
... while True:
|
| 725 |
+
... chunk = fobj.read(chunk_size)
|
| 726 |
+
... if not chunk:
|
| 727 |
+
... break
|
| 728 |
+
"""
|
| 729 |
+
|
| 730 |
+
@classmethod
|
| 731 |
+
def pandas(cls, *targs, **tqdm_kwargs):
|
| 732 |
+
"""Registers the current `tqdm` class with `pandas`."""
|
| 733 |
+
|
| 734 |
+
def trange(*args, **tqdm_kwargs):
|
| 735 |
+
"""Shortcut for `tqdm(range(*args), **tqdm_kwargs)`."""
|
| 736 |
+
|
| 737 |
+
Convenience Functions
|
| 738 |
+
~~~~~~~~~~~~~~~~~~~~~
|
| 739 |
+
|
| 740 |
+
.. code:: python
|
| 741 |
+
|
| 742 |
+
def tqdm.contrib.tenumerate(iterable, start=0, total=None,
|
| 743 |
+
tqdm_class=tqdm.auto.tqdm, **tqdm_kwargs):
|
| 744 |
+
"""Equivalent of `numpy.ndenumerate` or builtin `enumerate`."""
|
| 745 |
+
|
| 746 |
+
def tqdm.contrib.tzip(iter1, *iter2plus, **tqdm_kwargs):
|
| 747 |
+
"""Equivalent of builtin `zip`."""
|
| 748 |
+
|
| 749 |
+
def tqdm.contrib.tmap(function, *sequences, **tqdm_kwargs):
|
| 750 |
+
"""Equivalent of builtin `map`."""
|
| 751 |
+
|
| 752 |
+
Submodules
|
| 753 |
+
~~~~~~~~~~
|
| 754 |
+
|
| 755 |
+
.. code:: python
|
| 756 |
+
|
| 757 |
+
class tqdm.notebook.tqdm(tqdm.tqdm):
|
| 758 |
+
"""IPython/Jupyter Notebook widget."""
|
| 759 |
+
|
| 760 |
+
class tqdm.auto.tqdm(tqdm.tqdm):
|
| 761 |
+
"""Automatically chooses between `tqdm.notebook` and `tqdm.tqdm`."""
|
| 762 |
+
|
| 763 |
+
class tqdm.asyncio.tqdm(tqdm.tqdm):
|
| 764 |
+
"""Asynchronous version."""
|
| 765 |
+
@classmethod
|
| 766 |
+
def as_completed(cls, fs, *, loop=None, timeout=None, total=None,
|
| 767 |
+
**tqdm_kwargs):
|
| 768 |
+
"""Wrapper for `asyncio.as_completed`."""
|
| 769 |
+
|
| 770 |
+
class tqdm.gui.tqdm(tqdm.tqdm):
|
| 771 |
+
"""Matplotlib GUI version."""
|
| 772 |
+
|
| 773 |
+
class tqdm.tk.tqdm(tqdm.tqdm):
|
| 774 |
+
"""Tkinter GUI version."""
|
| 775 |
+
|
| 776 |
+
class tqdm.rich.tqdm(tqdm.tqdm):
|
| 777 |
+
"""`rich.progress` version."""
|
| 778 |
+
|
| 779 |
+
class tqdm.keras.TqdmCallback(keras.callbacks.Callback):
|
| 780 |
+
"""Keras callback for epoch and batch progress."""
|
| 781 |
+
|
| 782 |
+
class tqdm.dask.TqdmCallback(dask.callbacks.Callback):
|
| 783 |
+
"""Dask callback for task progress."""
|
| 784 |
+
|
| 785 |
+
|
| 786 |
+
``contrib``
|
| 787 |
+
+++++++++++
|
| 788 |
+
|
| 789 |
+
The ``tqdm.contrib`` package also contains experimental modules:
|
| 790 |
+
|
| 791 |
+
- `tqdm.contrib.itertools <https://tqdm.github.io/docs/contrib.itertools/>`_: Thin wrappers around ``itertools``
|
| 792 |
+
- `tqdm.contrib.concurrent <https://tqdm.github.io/docs/contrib.concurrent/>`_: Thin wrappers around ``concurrent.futures``
|
| 793 |
+
- `tqdm.contrib.slack <https://tqdm.github.io/docs/contrib.slack/>`_: Posts to `Slack <https://slack.com>`__ bots
|
| 794 |
+
- `tqdm.contrib.discord <https://tqdm.github.io/docs/contrib.discord/>`_: Posts to `Discord <https://discord.com>`__ bots
|
| 795 |
+
- `tqdm.contrib.telegram <https://tqdm.github.io/docs/contrib.telegram/>`_: Posts to `Telegram <https://telegram.org>`__ bots
|
| 796 |
+
- `tqdm.contrib.bells <https://tqdm.github.io/docs/shortcuts/>`_: Automagically enables all optional features
|
| 797 |
+
|
| 798 |
+
* ``auto``, ``pandas``, ``slack``, ``discord``, ``telegram``
|
| 799 |
+
|
| 800 |
+
.. image:: https://tqdm.github.io/img/screenshot-discord.png
|
| 801 |
+
:alt: Screenshot of `tqdm.contrib.discord` in action
|
| 802 |
+
|
| 803 |
+
Examples and Advanced Usage
|
| 804 |
+
---------------------------
|
| 805 |
+
|
| 806 |
+
- See the `examples <https://github.com/tqdm/tqdm/tree/master/examples>`__
|
| 807 |
+
folder;
|
| 808 |
+
- import the module and run ``help()``;
|
| 809 |
+
- consult the `wiki <https://github.com/tqdm/tqdm/wiki>`__;
|
| 810 |
+
|
| 811 |
+
* this has an
|
| 812 |
+
`excellent article <https://github.com/tqdm/tqdm/wiki/How-to-make-a-great-Progress-Bar>`__
|
| 813 |
+
on how to make a **great** progress bar;
|
| 814 |
+
|
| 815 |
+
- check out the `slides from PyData London <https://tqdm.github.io/PyData2019/slides.html>`__, or
|
| 816 |
+
- run the |binder-demo|.
|
| 817 |
+
|
| 818 |
+
Description and additional stats
|
| 819 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 820 |
+
|
| 821 |
+
Custom information can be displayed and updated dynamically on ``tqdm`` bars
|
| 822 |
+
with the ``desc`` and ``postfix`` arguments:
|
| 823 |
+
|
| 824 |
+
.. code:: python
|
| 825 |
+
|
| 826 |
+
from tqdm import tqdm, trange
|
| 827 |
+
from random import random, randint
|
| 828 |
+
from time import sleep
|
| 829 |
+
|
| 830 |
+
with trange(10) as t:
|
| 831 |
+
for i in t:
|
| 832 |
+
# Description will be displayed on the left
|
| 833 |
+
t.set_description('GEN %i' % i)
|
| 834 |
+
# Postfix will be displayed on the right,
|
| 835 |
+
# formatted automatically based on argument's datatype
|
| 836 |
+
t.set_postfix(loss=random(), gen=randint(1,999), str='h',
|
| 837 |
+
lst=[1, 2])
|
| 838 |
+
sleep(0.1)
|
| 839 |
+
|
| 840 |
+
with tqdm(total=10, bar_format="{postfix[0]} {postfix[1][value]:>8.2g}",
|
| 841 |
+
postfix=["Batch", {"value": 0}]) as t:
|
| 842 |
+
for i in range(10):
|
| 843 |
+
sleep(0.1)
|
| 844 |
+
t.postfix[1]["value"] = i / 2
|
| 845 |
+
t.update()
|
| 846 |
+
|
| 847 |
+
Points to remember when using ``{postfix[...]}`` in the ``bar_format`` string:
|
| 848 |
+
|
| 849 |
+
- ``postfix`` also needs to be passed as an initial argument in a compatible
|
| 850 |
+
format, and
|
| 851 |
+
- ``postfix`` will be auto-converted to a string if it is a ``dict``-like
|
| 852 |
+
object. To prevent this behaviour, insert an extra item into the dictionary
|
| 853 |
+
where the key is not a string.
|
| 854 |
+
|
| 855 |
+
Additional ``bar_format`` parameters may also be defined by overriding
|
| 856 |
+
``format_dict``, and the bar itself may be modified using ``ascii``:
|
| 857 |
+
|
| 858 |
+
.. code:: python
|
| 859 |
+
|
| 860 |
+
from tqdm import tqdm
|
| 861 |
+
class TqdmExtraFormat(tqdm):
|
| 862 |
+
"""Provides a `total_time` format parameter"""
|
| 863 |
+
@property
|
| 864 |
+
def format_dict(self):
|
| 865 |
+
d = super().format_dict
|
| 866 |
+
total_time = d["elapsed"] * (d["total"] or 0) / max(d["n"], 1)
|
| 867 |
+
d.update(total_time=self.format_interval(total_time) + " in total")
|
| 868 |
+
return d
|
| 869 |
+
|
| 870 |
+
for i in TqdmExtraFormat(
|
| 871 |
+
range(9), ascii=" .oO0",
|
| 872 |
+
bar_format="{total_time}: {percentage:.0f}%|{bar}{r_bar}"):
|
| 873 |
+
if i == 4:
|
| 874 |
+
break
|
| 875 |
+
|
| 876 |
+
.. code::
|
| 877 |
+
|
| 878 |
+
00:00 in total: 44%|0000. | 4/9 [00:00<00:00, 962.93it/s]
|
| 879 |
+
|
| 880 |
+
Note that ``{bar}`` also supports a format specifier ``[width][type]``.
|
| 881 |
+
|
| 882 |
+
- ``width``
|
| 883 |
+
|
| 884 |
+
* unspecified (default): automatic to fill ``ncols``
|
| 885 |
+
* ``int >= 0``: fixed width overriding ``ncols`` logic
|
| 886 |
+
* ``int < 0``: subtract from the automatic default
|
| 887 |
+
|
| 888 |
+
- ``type``
|
| 889 |
+
|
| 890 |
+
* ``a``: ascii (``ascii=True`` override)
|
| 891 |
+
* ``u``: unicode (``ascii=False`` override)
|
| 892 |
+
* ``b``: blank (``ascii=" "`` override)
|
| 893 |
+
|
| 894 |
+
This means a fixed bar with right-justified text may be created by using:
|
| 895 |
+
``bar_format="{l_bar}{bar:10}|{bar:-10b}right-justified"``
|
| 896 |
+
|
| 897 |
+
Nested progress bars
|
| 898 |
+
~~~~~~~~~~~~~~~~~~~~
|
| 899 |
+
|
| 900 |
+
``tqdm`` supports nested progress bars. Here's an example:
|
| 901 |
+
|
| 902 |
+
.. code:: python
|
| 903 |
+
|
| 904 |
+
from tqdm.auto import trange
|
| 905 |
+
from time import sleep
|
| 906 |
+
|
| 907 |
+
for i in trange(4, desc='1st loop'):
|
| 908 |
+
for j in trange(5, desc='2nd loop'):
|
| 909 |
+
for k in trange(50, desc='3rd loop', leave=False):
|
| 910 |
+
sleep(0.01)
|
| 911 |
+
|
| 912 |
+
For manual control over positioning (e.g. for multi-processing use),
|
| 913 |
+
you may specify ``position=n`` where ``n=0`` for the outermost bar,
|
| 914 |
+
``n=1`` for the next, and so on.
|
| 915 |
+
However, it's best to check if ``tqdm`` can work without manual ``position``
|
| 916 |
+
first.
|
| 917 |
+
|
| 918 |
+
.. code:: python
|
| 919 |
+
|
| 920 |
+
from time import sleep
|
| 921 |
+
from tqdm import trange, tqdm
|
| 922 |
+
from multiprocessing import Pool, RLock, freeze_support
|
| 923 |
+
|
| 924 |
+
L = list(range(9))
|
| 925 |
+
|
| 926 |
+
def progresser(n):
|
| 927 |
+
interval = 0.001 / (n + 2)
|
| 928 |
+
total = 5000
|
| 929 |
+
text = f"#{n}, est. {interval * total:<04.2}s"
|
| 930 |
+
for _ in trange(total, desc=text, position=n):
|
| 931 |
+
sleep(interval)
|
| 932 |
+
|
| 933 |
+
if __name__ == '__main__':
|
| 934 |
+
freeze_support() # for Windows support
|
| 935 |
+
tqdm.set_lock(RLock()) # for managing output contention
|
| 936 |
+
p = Pool(initializer=tqdm.set_lock, initargs=(tqdm.get_lock(),))
|
| 937 |
+
p.map(progresser, L)
|
| 938 |
+
|
| 939 |
+
Note that in Python 3, ``tqdm.write`` is thread-safe:
|
| 940 |
+
|
| 941 |
+
.. code:: python
|
| 942 |
+
|
| 943 |
+
from time import sleep
|
| 944 |
+
from tqdm import tqdm, trange
|
| 945 |
+
from concurrent.futures import ThreadPoolExecutor
|
| 946 |
+
|
| 947 |
+
L = list(range(9))
|
| 948 |
+
|
| 949 |
+
def progresser(n):
|
| 950 |
+
interval = 0.001 / (n + 2)
|
| 951 |
+
total = 5000
|
| 952 |
+
text = f"#{n}, est. {interval * total:<04.2}s"
|
| 953 |
+
for _ in trange(total, desc=text):
|
| 954 |
+
sleep(interval)
|
| 955 |
+
if n == 6:
|
| 956 |
+
tqdm.write("n == 6 completed.")
|
| 957 |
+
tqdm.write("`tqdm.write()` is thread-safe in py3!")
|
| 958 |
+
|
| 959 |
+
if __name__ == '__main__':
|
| 960 |
+
with ThreadPoolExecutor() as p:
|
| 961 |
+
p.map(progresser, L)
|
| 962 |
+
|
| 963 |
+
Hooks and callbacks
|
| 964 |
+
~~~~~~~~~~~~~~~~~~~
|
| 965 |
+
|
| 966 |
+
``tqdm`` can easily support callbacks/hooks and manual updates.
|
| 967 |
+
Here's an example with ``urllib``:
|
| 968 |
+
|
| 969 |
+
**``urllib.urlretrieve`` documentation**
|
| 970 |
+
|
| 971 |
+
| [...]
|
| 972 |
+
| If present, the hook function will be called once
|
| 973 |
+
| on establishment of the network connection and once after each block read
|
| 974 |
+
| thereafter. The hook will be passed three arguments; a count of blocks
|
| 975 |
+
| transferred so far, a block size in bytes, and the total size of the file.
|
| 976 |
+
| [...]
|
| 977 |
+
|
| 978 |
+
.. code:: python
|
| 979 |
+
|
| 980 |
+
import urllib, os
|
| 981 |
+
from tqdm import tqdm
|
| 982 |
+
urllib = getattr(urllib, 'request', urllib)
|
| 983 |
+
|
| 984 |
+
class TqdmUpTo(tqdm):
|
| 985 |
+
"""Provides `update_to(n)` which uses `tqdm.update(delta_n)`."""
|
| 986 |
+
def update_to(self, b=1, bsize=1, tsize=None):
|
| 987 |
+
"""
|
| 988 |
+
b : int, optional
|
| 989 |
+
Number of blocks transferred so far [default: 1].
|
| 990 |
+
bsize : int, optional
|
| 991 |
+
Size of each block (in tqdm units) [default: 1].
|
| 992 |
+
tsize : int, optional
|
| 993 |
+
Total size (in tqdm units). If [default: None] remains unchanged.
|
| 994 |
+
"""
|
| 995 |
+
if tsize is not None:
|
| 996 |
+
self.total = tsize
|
| 997 |
+
return self.update(b * bsize - self.n) # also sets self.n = b * bsize
|
| 998 |
+
|
| 999 |
+
eg_link = "https://cgi.cdcl.ml/matryoshka.zip"
|
| 1000 |
+
with TqdmUpTo(unit='B', unit_scale=True, unit_divisor=1024, miniters=1,
|
| 1001 |
+
desc=eg_link.split('/')[-1]) as t: # all optional kwargs
|
| 1002 |
+
urllib.urlretrieve(eg_link, filename=os.devnull,
|
| 1003 |
+
reporthook=t.update_to, data=None)
|
| 1004 |
+
t.total = t.n
|
| 1005 |
+
|
| 1006 |
+
Inspired by `twine#242 <https://github.com/pypa/twine/pull/242>`__.
|
| 1007 |
+
Functional alternative in
|
| 1008 |
+
`examples/tqdm_wget.py <https://github.com/tqdm/tqdm/blob/master/examples/tqdm_wget.py>`__.
|
| 1009 |
+
|
| 1010 |
+
It is recommend to use ``miniters=1`` whenever there is potentially
|
| 1011 |
+
large differences in iteration speed (e.g. downloading a file over
|
| 1012 |
+
a patchy connection).
|
| 1013 |
+
|
| 1014 |
+
**Wrapping read/write methods**
|
| 1015 |
+
|
| 1016 |
+
To measure throughput through a file-like object's ``read`` or ``write``
|
| 1017 |
+
methods, use ``CallbackIOWrapper``:
|
| 1018 |
+
|
| 1019 |
+
.. code:: python
|
| 1020 |
+
|
| 1021 |
+
from tqdm.auto import tqdm
|
| 1022 |
+
from tqdm.utils import CallbackIOWrapper
|
| 1023 |
+
|
| 1024 |
+
with tqdm(total=file_obj.size,
|
| 1025 |
+
unit='B', unit_scale=True, unit_divisor=1024) as t:
|
| 1026 |
+
fobj = CallbackIOWrapper(t.update, file_obj, "read")
|
| 1027 |
+
while True:
|
| 1028 |
+
chunk = fobj.read(chunk_size)
|
| 1029 |
+
if not chunk:
|
| 1030 |
+
break
|
| 1031 |
+
t.reset()
|
| 1032 |
+
# ... continue to use `t` for something else
|
| 1033 |
+
|
| 1034 |
+
Alternatively, use the even simpler ``wrapattr`` convenience function,
|
| 1035 |
+
which would condense both the ``urllib`` and ``CallbackIOWrapper`` examples
|
| 1036 |
+
down to:
|
| 1037 |
+
|
| 1038 |
+
.. code:: python
|
| 1039 |
+
|
| 1040 |
+
import urllib, os
|
| 1041 |
+
from tqdm import tqdm
|
| 1042 |
+
|
| 1043 |
+
eg_link = "https://cgi.cdcl.ml/matryoshka.zip"
|
| 1044 |
+
response = getattr(urllib, 'request', urllib).urlopen(eg_link)
|
| 1045 |
+
with tqdm.wrapattr(open(os.devnull, "wb"), "write",
|
| 1046 |
+
miniters=1, desc=eg_link.split('/')[-1],
|
| 1047 |
+
total=getattr(response, 'length', None)) as fout:
|
| 1048 |
+
for chunk in response:
|
| 1049 |
+
fout.write(chunk)
|
| 1050 |
+
|
| 1051 |
+
The ``requests`` equivalent is nearly identical:
|
| 1052 |
+
|
| 1053 |
+
.. code:: python
|
| 1054 |
+
|
| 1055 |
+
import requests, os
|
| 1056 |
+
from tqdm import tqdm
|
| 1057 |
+
|
| 1058 |
+
eg_link = "https://cgi.cdcl.ml/matryoshka.zip"
|
| 1059 |
+
response = requests.get(eg_link, stream=True)
|
| 1060 |
+
with tqdm.wrapattr(open(os.devnull, "wb"), "write",
|
| 1061 |
+
miniters=1, desc=eg_link.split('/')[-1],
|
| 1062 |
+
total=int(response.headers.get('content-length', 0))) as fout:
|
| 1063 |
+
for chunk in response.iter_content(chunk_size=4096):
|
| 1064 |
+
fout.write(chunk)
|
| 1065 |
+
|
| 1066 |
+
**Custom callback**
|
| 1067 |
+
|
| 1068 |
+
``tqdm`` is known for intelligently skipping unnecessary displays. To make a
|
| 1069 |
+
custom callback take advantage of this, simply use the return value of
|
| 1070 |
+
``update()``. This is set to ``True`` if a ``display()`` was triggered.
|
| 1071 |
+
|
| 1072 |
+
.. code:: python
|
| 1073 |
+
|
| 1074 |
+
from tqdm.auto import tqdm as std_tqdm
|
| 1075 |
+
|
| 1076 |
+
def external_callback(*args, **kwargs):
|
| 1077 |
+
...
|
| 1078 |
+
|
| 1079 |
+
class TqdmExt(std_tqdm):
|
| 1080 |
+
def update(self, n=1):
|
| 1081 |
+
displayed = super().update(n)
|
| 1082 |
+
if displayed:
|
| 1083 |
+
external_callback(**self.format_dict)
|
| 1084 |
+
return displayed
|
| 1085 |
+
|
| 1086 |
+
``asyncio``
|
| 1087 |
+
~~~~~~~~~~~
|
| 1088 |
+
|
| 1089 |
+
Note that ``break`` isn't currently caught by asynchronous iterators.
|
| 1090 |
+
This means that ``tqdm`` cannot clean up after itself in this case:
|
| 1091 |
+
|
| 1092 |
+
.. code:: python
|
| 1093 |
+
|
| 1094 |
+
from tqdm.asyncio import tqdm
|
| 1095 |
+
|
| 1096 |
+
async for i in tqdm(range(9)):
|
| 1097 |
+
if i == 2:
|
| 1098 |
+
break
|
| 1099 |
+
|
| 1100 |
+
Instead, either call ``pbar.close()`` manually or use the context manager syntax:
|
| 1101 |
+
|
| 1102 |
+
.. code:: python
|
| 1103 |
+
|
| 1104 |
+
from tqdm.asyncio import tqdm
|
| 1105 |
+
|
| 1106 |
+
with tqdm(range(9)) as pbar:
|
| 1107 |
+
async for i in pbar:
|
| 1108 |
+
if i == 2:
|
| 1109 |
+
break
|
| 1110 |
+
|
| 1111 |
+
Pandas Integration
|
| 1112 |
+
~~~~~~~~~~~~~~~~~~
|
| 1113 |
+
|
| 1114 |
+
Due to popular demand we've added support for ``pandas`` -- here's an example
|
| 1115 |
+
for ``DataFrame.progress_apply`` and ``DataFrameGroupBy.progress_apply``:
|
| 1116 |
+
|
| 1117 |
+
.. code:: python
|
| 1118 |
+
|
| 1119 |
+
import pandas as pd
|
| 1120 |
+
import numpy as np
|
| 1121 |
+
from tqdm import tqdm
|
| 1122 |
+
|
| 1123 |
+
df = pd.DataFrame(np.random.randint(0, 100, (100000, 6)))
|
| 1124 |
+
|
| 1125 |
+
# Register `pandas.progress_apply` and `pandas.Series.map_apply` with `tqdm`
|
| 1126 |
+
# (can use `tqdm.gui.tqdm`, `tqdm.notebook.tqdm`, optional kwargs, etc.)
|
| 1127 |
+
tqdm.pandas(desc="my bar!")
|
| 1128 |
+
|
| 1129 |
+
# Now you can use `progress_apply` instead of `apply`
|
| 1130 |
+
# and `progress_map` instead of `map`
|
| 1131 |
+
df.progress_apply(lambda x: x**2)
|
| 1132 |
+
# can also groupby:
|
| 1133 |
+
# df.groupby(0).progress_apply(lambda x: x**2)
|
| 1134 |
+
|
| 1135 |
+
In case you're interested in how this works (and how to modify it for your
|
| 1136 |
+
own callbacks), see the
|
| 1137 |
+
`examples <https://github.com/tqdm/tqdm/tree/master/examples>`__
|
| 1138 |
+
folder or import the module and run ``help()``.
|
| 1139 |
+
|
| 1140 |
+
Keras Integration
|
| 1141 |
+
~~~~~~~~~~~~~~~~~
|
| 1142 |
+
|
| 1143 |
+
A ``keras`` callback is also available:
|
| 1144 |
+
|
| 1145 |
+
.. code:: python
|
| 1146 |
+
|
| 1147 |
+
from tqdm.keras import TqdmCallback
|
| 1148 |
+
|
| 1149 |
+
...
|
| 1150 |
+
|
| 1151 |
+
model.fit(..., verbose=0, callbacks=[TqdmCallback()])
|
| 1152 |
+
|
| 1153 |
+
Dask Integration
|
| 1154 |
+
~~~~~~~~~~~~~~~~
|
| 1155 |
+
|
| 1156 |
+
A ``dask`` callback is also available:
|
| 1157 |
+
|
| 1158 |
+
.. code:: python
|
| 1159 |
+
|
| 1160 |
+
from tqdm.dask import TqdmCallback
|
| 1161 |
+
|
| 1162 |
+
with TqdmCallback(desc="compute"):
|
| 1163 |
+
...
|
| 1164 |
+
arr.compute()
|
| 1165 |
+
|
| 1166 |
+
# or use callback globally
|
| 1167 |
+
cb = TqdmCallback(desc="global")
|
| 1168 |
+
cb.register()
|
| 1169 |
+
arr.compute()
|
| 1170 |
+
|
| 1171 |
+
IPython/Jupyter Integration
|
| 1172 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 1173 |
+
|
| 1174 |
+
IPython/Jupyter is supported via the ``tqdm.notebook`` submodule:
|
| 1175 |
+
|
| 1176 |
+
.. code:: python
|
| 1177 |
+
|
| 1178 |
+
from tqdm.notebook import trange, tqdm
|
| 1179 |
+
from time import sleep
|
| 1180 |
+
|
| 1181 |
+
for i in trange(3, desc='1st loop'):
|
| 1182 |
+
for j in tqdm(range(100), desc='2nd loop'):
|
| 1183 |
+
sleep(0.01)
|
| 1184 |
+
|
| 1185 |
+
In addition to ``tqdm`` features, the submodule provides a native Jupyter
|
| 1186 |
+
widget (compatible with IPython v1-v4 and Jupyter), fully working nested bars
|
| 1187 |
+
and colour hints (blue: normal, green: completed, red: error/interrupt,
|
| 1188 |
+
light blue: no ETA); as demonstrated below.
|
| 1189 |
+
|
| 1190 |
+
|Screenshot-Jupyter1|
|
| 1191 |
+
|Screenshot-Jupyter2|
|
| 1192 |
+
|Screenshot-Jupyter3|
|
| 1193 |
+
|
| 1194 |
+
The ``notebook`` version supports percentage or pixels for overall width
|
| 1195 |
+
(e.g.: ``ncols='100%'`` or ``ncols='480px'``).
|
| 1196 |
+
|
| 1197 |
+
It is also possible to let ``tqdm`` automatically choose between
|
| 1198 |
+
console or notebook versions by using the ``autonotebook`` submodule:
|
| 1199 |
+
|
| 1200 |
+
.. code:: python
|
| 1201 |
+
|
| 1202 |
+
from tqdm.autonotebook import tqdm
|
| 1203 |
+
tqdm.pandas()
|
| 1204 |
+
|
| 1205 |
+
Note that this will issue a ``TqdmExperimentalWarning`` if run in a notebook
|
| 1206 |
+
since it is not meant to be possible to distinguish between ``jupyter notebook``
|
| 1207 |
+
and ``jupyter console``. Use ``auto`` instead of ``autonotebook`` to suppress
|
| 1208 |
+
this warning.
|
| 1209 |
+
|
| 1210 |
+
Note that notebooks will display the bar in the cell where it was created.
|
| 1211 |
+
This may be a different cell from the one where it is used.
|
| 1212 |
+
If this is not desired, either
|
| 1213 |
+
|
| 1214 |
+
- delay the creation of the bar to the cell where it must be displayed, or
|
| 1215 |
+
- create the bar with ``display=False``, and in a later cell call
|
| 1216 |
+
``display(bar.container)``:
|
| 1217 |
+
|
| 1218 |
+
.. code:: python
|
| 1219 |
+
|
| 1220 |
+
from tqdm.notebook import tqdm
|
| 1221 |
+
pbar = tqdm(..., display=False)
|
| 1222 |
+
|
| 1223 |
+
.. code:: python
|
| 1224 |
+
|
| 1225 |
+
# different cell
|
| 1226 |
+
display(pbar.container)
|
| 1227 |
+
|
| 1228 |
+
The ``keras`` callback has a ``display()`` method which can be used likewise:
|
| 1229 |
+
|
| 1230 |
+
.. code:: python
|
| 1231 |
+
|
| 1232 |
+
from tqdm.keras import TqdmCallback
|
| 1233 |
+
cbk = TqdmCallback(display=False)
|
| 1234 |
+
|
| 1235 |
+
.. code:: python
|
| 1236 |
+
|
| 1237 |
+
# different cell
|
| 1238 |
+
cbk.display()
|
| 1239 |
+
model.fit(..., verbose=0, callbacks=[cbk])
|
| 1240 |
+
|
| 1241 |
+
Another possibility is to have a single bar (near the top of the notebook)
|
| 1242 |
+
which is constantly re-used (using ``reset()`` rather than ``close()``).
|
| 1243 |
+
For this reason, the notebook version (unlike the CLI version) does not
|
| 1244 |
+
automatically call ``close()`` upon ``Exception``.
|
| 1245 |
+
|
| 1246 |
+
.. code:: python
|
| 1247 |
+
|
| 1248 |
+
from tqdm.notebook import tqdm
|
| 1249 |
+
pbar = tqdm()
|
| 1250 |
+
|
| 1251 |
+
.. code:: python
|
| 1252 |
+
|
| 1253 |
+
# different cell
|
| 1254 |
+
iterable = range(100)
|
| 1255 |
+
pbar.reset(total=len(iterable)) # initialise with new `total`
|
| 1256 |
+
for i in iterable:
|
| 1257 |
+
pbar.update()
|
| 1258 |
+
pbar.refresh() # force print final status but don't `close()`
|
| 1259 |
+
|
| 1260 |
+
Custom Integration
|
| 1261 |
+
~~~~~~~~~~~~~~~~~~
|
| 1262 |
+
|
| 1263 |
+
To change the default arguments (such as making ``dynamic_ncols=True``),
|
| 1264 |
+
simply use built-in Python magic:
|
| 1265 |
+
|
| 1266 |
+
.. code:: python
|
| 1267 |
+
|
| 1268 |
+
from functools import partial
|
| 1269 |
+
from tqdm import tqdm as std_tqdm
|
| 1270 |
+
tqdm = partial(std_tqdm, dynamic_ncols=True)
|
| 1271 |
+
|
| 1272 |
+
For further customisation,
|
| 1273 |
+
``tqdm`` may be inherited from to create custom callbacks (as with the
|
| 1274 |
+
``TqdmUpTo`` example `above <#hooks-and-callbacks>`__) or for custom frontends
|
| 1275 |
+
(e.g. GUIs such as notebook or plotting packages). In the latter case:
|
| 1276 |
+
|
| 1277 |
+
1. ``def __init__()`` to call ``super().__init__(..., gui=True)`` to disable
|
| 1278 |
+
terminal ``status_printer`` creation.
|
| 1279 |
+
2. Redefine: ``close()``, ``clear()``, ``display()``.
|
| 1280 |
+
|
| 1281 |
+
Consider overloading ``display()`` to use e.g.
|
| 1282 |
+
``self.frontend(**self.format_dict)`` instead of ``self.sp(repr(self))``.
|
| 1283 |
+
|
| 1284 |
+
Some submodule examples of inheritance:
|
| 1285 |
+
|
| 1286 |
+
- `tqdm/notebook.py <https://github.com/tqdm/tqdm/blob/master/tqdm/notebook.py>`__
|
| 1287 |
+
- `tqdm/gui.py <https://github.com/tqdm/tqdm/blob/master/tqdm/gui.py>`__
|
| 1288 |
+
- `tqdm/tk.py <https://github.com/tqdm/tqdm/blob/master/tqdm/tk.py>`__
|
| 1289 |
+
- `tqdm/contrib/slack.py <https://github.com/tqdm/tqdm/blob/master/tqdm/contrib/slack.py>`__
|
| 1290 |
+
- `tqdm/contrib/discord.py <https://github.com/tqdm/tqdm/blob/master/tqdm/contrib/discord.py>`__
|
| 1291 |
+
- `tqdm/contrib/telegram.py <https://github.com/tqdm/tqdm/blob/master/tqdm/contrib/telegram.py>`__
|
| 1292 |
+
|
| 1293 |
+
Dynamic Monitor/Meter
|
| 1294 |
+
~~~~~~~~~~~~~~~~~~~~~
|
| 1295 |
+
|
| 1296 |
+
You can use a ``tqdm`` as a meter which is not monotonically increasing.
|
| 1297 |
+
This could be because ``n`` decreases (e.g. a CPU usage monitor) or ``total``
|
| 1298 |
+
changes.
|
| 1299 |
+
|
| 1300 |
+
One example would be recursively searching for files. The ``total`` is the
|
| 1301 |
+
number of objects found so far, while ``n`` is the number of those objects which
|
| 1302 |
+
are files (rather than folders):
|
| 1303 |
+
|
| 1304 |
+
.. code:: python
|
| 1305 |
+
|
| 1306 |
+
from tqdm import tqdm
|
| 1307 |
+
import os.path
|
| 1308 |
+
|
| 1309 |
+
def find_files_recursively(path, show_progress=True):
|
| 1310 |
+
files = []
|
| 1311 |
+
# total=1 assumes `path` is a file
|
| 1312 |
+
t = tqdm(total=1, unit="file", disable=not show_progress)
|
| 1313 |
+
if not os.path.exists(path):
|
| 1314 |
+
raise IOError("Cannot find:" + path)
|
| 1315 |
+
|
| 1316 |
+
def append_found_file(f):
|
| 1317 |
+
files.append(f)
|
| 1318 |
+
t.update()
|
| 1319 |
+
|
| 1320 |
+
def list_found_dir(path):
|
| 1321 |
+
"""returns os.listdir(path) assuming os.path.isdir(path)"""
|
| 1322 |
+
listing = os.listdir(path)
|
| 1323 |
+
# subtract 1 since a "file" we found was actually this directory
|
| 1324 |
+
t.total += len(listing) - 1
|
| 1325 |
+
# fancy way to give info without forcing a refresh
|
| 1326 |
+
t.set_postfix(dir=path[-10:], refresh=False)
|
| 1327 |
+
t.update(0) # may trigger a refresh
|
| 1328 |
+
return listing
|
| 1329 |
+
|
| 1330 |
+
def recursively_search(path):
|
| 1331 |
+
if os.path.isdir(path):
|
| 1332 |
+
for f in list_found_dir(path):
|
| 1333 |
+
recursively_search(os.path.join(path, f))
|
| 1334 |
+
else:
|
| 1335 |
+
append_found_file(path)
|
| 1336 |
+
|
| 1337 |
+
recursively_search(path)
|
| 1338 |
+
t.set_postfix(dir=path)
|
| 1339 |
+
t.close()
|
| 1340 |
+
return files
|
| 1341 |
+
|
| 1342 |
+
Using ``update(0)`` is a handy way to let ``tqdm`` decide when to trigger a
|
| 1343 |
+
display refresh to avoid console spamming.
|
| 1344 |
+
|
| 1345 |
+
Writing messages
|
| 1346 |
+
~~~~~~~~~~~~~~~~
|
| 1347 |
+
|
| 1348 |
+
This is a work in progress (see
|
| 1349 |
+
`#737 <https://github.com/tqdm/tqdm/issues/737>`__).
|
| 1350 |
+
|
| 1351 |
+
Since ``tqdm`` uses a simple printing mechanism to display progress bars,
|
| 1352 |
+
you should not write any message in the terminal using ``print()`` while
|
| 1353 |
+
a progress bar is open.
|
| 1354 |
+
|
| 1355 |
+
To write messages in the terminal without any collision with ``tqdm`` bar
|
| 1356 |
+
display, a ``.write()`` method is provided:
|
| 1357 |
+
|
| 1358 |
+
.. code:: python
|
| 1359 |
+
|
| 1360 |
+
from tqdm.auto import tqdm, trange
|
| 1361 |
+
from time import sleep
|
| 1362 |
+
|
| 1363 |
+
bar = trange(10)
|
| 1364 |
+
for i in bar:
|
| 1365 |
+
# Print using tqdm class method .write()
|
| 1366 |
+
sleep(0.1)
|
| 1367 |
+
if not (i % 3):
|
| 1368 |
+
tqdm.write("Done task %i" % i)
|
| 1369 |
+
# Can also use bar.write()
|
| 1370 |
+
|
| 1371 |
+
By default, this will print to standard output ``sys.stdout``. but you can
|
| 1372 |
+
specify any file-like object using the ``file`` argument. For example, this
|
| 1373 |
+
can be used to redirect the messages writing to a log file or class.
|
| 1374 |
+
|
| 1375 |
+
Redirecting writing
|
| 1376 |
+
~~~~~~~~~~~~~~~~~~~
|
| 1377 |
+
|
| 1378 |
+
If using a library that can print messages to the console, editing the library
|
| 1379 |
+
by replacing ``print()`` with ``tqdm.write()`` may not be desirable.
|
| 1380 |
+
In that case, redirecting ``sys.stdout`` to ``tqdm.write()`` is an option.
|
| 1381 |
+
|
| 1382 |
+
To redirect ``sys.stdout``, create a file-like class that will write
|
| 1383 |
+
any input string to ``tqdm.write()``, and supply the arguments
|
| 1384 |
+
``file=sys.stdout, dynamic_ncols=True``.
|
| 1385 |
+
|
| 1386 |
+
A reusable canonical example is given below:
|
| 1387 |
+
|
| 1388 |
+
.. code:: python
|
| 1389 |
+
|
| 1390 |
+
from time import sleep
|
| 1391 |
+
import contextlib
|
| 1392 |
+
import sys
|
| 1393 |
+
from tqdm import tqdm
|
| 1394 |
+
from tqdm.contrib import DummyTqdmFile
|
| 1395 |
+
|
| 1396 |
+
|
| 1397 |
+
@contextlib.contextmanager
|
| 1398 |
+
def std_out_err_redirect_tqdm():
|
| 1399 |
+
orig_out_err = sys.stdout, sys.stderr
|
| 1400 |
+
try:
|
| 1401 |
+
sys.stdout, sys.stderr = map(DummyTqdmFile, orig_out_err)
|
| 1402 |
+
yield orig_out_err[0]
|
| 1403 |
+
# Relay exceptions
|
| 1404 |
+
except Exception as exc:
|
| 1405 |
+
raise exc
|
| 1406 |
+
# Always restore sys.stdout/err if necessary
|
| 1407 |
+
finally:
|
| 1408 |
+
sys.stdout, sys.stderr = orig_out_err
|
| 1409 |
+
|
| 1410 |
+
def some_fun(i):
|
| 1411 |
+
print("Fee, fi, fo,".split()[i])
|
| 1412 |
+
|
| 1413 |
+
# Redirect stdout to tqdm.write() (don't forget the `as save_stdout`)
|
| 1414 |
+
with std_out_err_redirect_tqdm() as orig_stdout:
|
| 1415 |
+
# tqdm needs the original stdout
|
| 1416 |
+
# and dynamic_ncols=True to autodetect console width
|
| 1417 |
+
for i in tqdm(range(3), file=orig_stdout, dynamic_ncols=True):
|
| 1418 |
+
sleep(.5)
|
| 1419 |
+
some_fun(i)
|
| 1420 |
+
|
| 1421 |
+
# After the `with`, printing is restored
|
| 1422 |
+
print("Done!")
|
| 1423 |
+
|
| 1424 |
+
Redirecting ``logging``
|
| 1425 |
+
~~~~~~~~~~~~~~~~~~~~~~~
|
| 1426 |
+
|
| 1427 |
+
Similar to ``sys.stdout``/``sys.stderr`` as detailed above, console ``logging``
|
| 1428 |
+
may also be redirected to ``tqdm.write()``.
|
| 1429 |
+
|
| 1430 |
+
Warning: if also redirecting ``sys.stdout``/``sys.stderr``, make sure to
|
| 1431 |
+
redirect ``logging`` first if needed.
|
| 1432 |
+
|
| 1433 |
+
Helper methods are available in ``tqdm.contrib.logging``. For example:
|
| 1434 |
+
|
| 1435 |
+
.. code:: python
|
| 1436 |
+
|
| 1437 |
+
import logging
|
| 1438 |
+
from tqdm import trange
|
| 1439 |
+
from tqdm.contrib.logging import logging_redirect_tqdm
|
| 1440 |
+
|
| 1441 |
+
LOG = logging.getLogger(__name__)
|
| 1442 |
+
|
| 1443 |
+
if __name__ == '__main__':
|
| 1444 |
+
logging.basicConfig(level=logging.INFO)
|
| 1445 |
+
with logging_redirect_tqdm():
|
| 1446 |
+
for i in trange(9):
|
| 1447 |
+
if i == 4:
|
| 1448 |
+
LOG.info("console logging redirected to `tqdm.write()`")
|
| 1449 |
+
# logging restored
|
| 1450 |
+
|
| 1451 |
+
Monitoring thread, intervals and miniters
|
| 1452 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 1453 |
+
|
| 1454 |
+
``tqdm`` implements a few tricks to increase efficiency and reduce overhead.
|
| 1455 |
+
|
| 1456 |
+
- Avoid unnecessary frequent bar refreshing: ``mininterval`` defines how long
|
| 1457 |
+
to wait between each refresh. ``tqdm`` always gets updated in the background,
|
| 1458 |
+
but it will display only every ``mininterval``.
|
| 1459 |
+
- Reduce number of calls to check system clock/time.
|
| 1460 |
+
- ``mininterval`` is more intuitive to configure than ``miniters``.
|
| 1461 |
+
A clever adjustment system ``dynamic_miniters`` will automatically adjust
|
| 1462 |
+
``miniters`` to the amount of iterations that fit into time ``mininterval``.
|
| 1463 |
+
Essentially, ``tqdm`` will check if it's time to print without actually
|
| 1464 |
+
checking time. This behaviour can be still be bypassed by manually setting
|
| 1465 |
+
``miniters``.
|
| 1466 |
+
|
| 1467 |
+
However, consider a case with a combination of fast and slow iterations.
|
| 1468 |
+
After a few fast iterations, ``dynamic_miniters`` will set ``miniters`` to a
|
| 1469 |
+
large number. When iteration rate subsequently slows, ``miniters`` will
|
| 1470 |
+
remain large and thus reduce display update frequency. To address this:
|
| 1471 |
+
|
| 1472 |
+
- ``maxinterval`` defines the maximum time between display refreshes.
|
| 1473 |
+
A concurrent monitoring thread checks for overdue updates and forces one
|
| 1474 |
+
where necessary.
|
| 1475 |
+
|
| 1476 |
+
The monitoring thread should not have a noticeable overhead, and guarantees
|
| 1477 |
+
updates at least every 10 seconds by default.
|
| 1478 |
+
This value can be directly changed by setting the ``monitor_interval`` of
|
| 1479 |
+
any ``tqdm`` instance (i.e. ``t = tqdm.tqdm(...); t.monitor_interval = 2``).
|
| 1480 |
+
The monitor thread may be disabled application-wide by setting
|
| 1481 |
+
``tqdm.tqdm.monitor_interval = 0`` before instantiation of any ``tqdm`` bar.
|
| 1482 |
+
|
| 1483 |
+
|
| 1484 |
+
Merch
|
| 1485 |
+
-----
|
| 1486 |
+
|
| 1487 |
+
You can buy `tqdm branded merch <https://tqdm.github.io/merch>`__ now!
|
| 1488 |
+
|
| 1489 |
+
Contributions
|
| 1490 |
+
-------------
|
| 1491 |
+
|
| 1492 |
+
|GitHub-Commits| |GitHub-Issues| |GitHub-PRs| |OpenHub-Status| |GitHub-Contributions| |CII Best Practices|
|
| 1493 |
+
|
| 1494 |
+
All source code is hosted on `GitHub <https://github.com/tqdm/tqdm>`__.
|
| 1495 |
+
Contributions are welcome.
|
| 1496 |
+
|
| 1497 |
+
See the
|
| 1498 |
+
`CONTRIBUTING <https://github.com/tqdm/tqdm/blob/master/CONTRIBUTING.md>`__
|
| 1499 |
+
file for more information.
|
| 1500 |
+
|
| 1501 |
+
Developers who have contributed more that 5 *loc* (surviving lines of code):
|
| 1502 |
+
|
| 1503 |
+
|git-fame|
|
| 1504 |
+
|
| 1505 |
+
Honourable mentions:
|
| 1506 |
+
|
| 1507 |
+
- Casper da Costa-Luis `casperdcl <https://github.com/casperdcl>`__ primary maintainer |Gift-Casper|
|
| 1508 |
+
- Stephen Larroque `lrq3000 <https://github.com/lrq3000>`__ maintainer
|
| 1509 |
+
- Hadrien Mary `hadim <https://github.com/hadim>`__ maintainer
|
| 1510 |
+
- Mikhail Korobov `kmike <https://github.com/kmike>`__ maintainer
|
| 1511 |
+
- Noam Yorav-Raphael `noamraph <https://github.com/noamraph>`__ original author
|
| 1512 |
+
|
| 1513 |
+
Ports to Other Languages
|
| 1514 |
+
~~~~~~~~~~~~~~~~~~~~~~~~
|
| 1515 |
+
|
| 1516 |
+
A list is available on
|
| 1517 |
+
`this wiki page <https://github.com/tqdm/tqdm/wiki/tqdm-ports>`__.
|
| 1518 |
+
|
| 1519 |
+
|
| 1520 |
+
LICENCE
|
| 1521 |
+
-------
|
| 1522 |
+
|
| 1523 |
+
Open Source (OSI approved): |LICENCE|
|
| 1524 |
+
|
| 1525 |
+
Citation information: |DOI|
|
| 1526 |
+
|
| 1527 |
+
|README-Hits| (Since 19 May 2016)
|
| 1528 |
+
|
| 1529 |
+
.. |Logo| image:: https://tqdm.github.io/img/logo.gif
|
| 1530 |
+
.. |Screenshot| image:: https://tqdm.github.io/img/tqdm.gif
|
| 1531 |
+
.. |Video| image:: https://tqdm.github.io/img/video.jpg
|
| 1532 |
+
:target: https://tqdm.github.io/video
|
| 1533 |
+
.. |Slides| image:: https://tqdm.github.io/img/slides.jpg
|
| 1534 |
+
:target: https://tqdm.github.io/PyData2019/slides.html
|
| 1535 |
+
.. |Merch| image:: https://tqdm.github.io/img/merch.jpg
|
| 1536 |
+
:target: https://tqdm.github.io/merch
|
| 1537 |
+
.. |Build-Status| image:: https://img.shields.io/github/actions/workflow/status/tqdm/tqdm/test.yml?branch=master&label=tqdm&logo=GitHub
|
| 1538 |
+
:target: https://github.com/tqdm/tqdm/actions/workflows/test.yml
|
| 1539 |
+
.. |Coverage-Status| image:: https://img.shields.io/coveralls/github/tqdm/tqdm/master?logo=coveralls
|
| 1540 |
+
:target: https://coveralls.io/github/tqdm/tqdm
|
| 1541 |
+
.. |Branch-Coverage-Status| image:: https://codecov.io/gh/tqdm/tqdm/branch/master/graph/badge.svg
|
| 1542 |
+
:target: https://codecov.io/gh/tqdm/tqdm
|
| 1543 |
+
.. |Codacy-Grade| image:: https://app.codacy.com/project/badge/Grade/3f965571598f44549c7818f29cdcf177
|
| 1544 |
+
:target: https://app.codacy.com/gh/tqdm/tqdm/dashboard
|
| 1545 |
+
.. |CII Best Practices| image:: https://bestpractices.coreinfrastructure.org/projects/3264/badge
|
| 1546 |
+
:target: https://bestpractices.coreinfrastructure.org/projects/3264
|
| 1547 |
+
.. |GitHub-Status| image:: https://img.shields.io/github/tag/tqdm/tqdm.svg?maxAge=86400&logo=github&logoColor=white
|
| 1548 |
+
:target: https://github.com/tqdm/tqdm/releases
|
| 1549 |
+
.. |GitHub-Forks| image:: https://img.shields.io/github/forks/tqdm/tqdm.svg?logo=github&logoColor=white
|
| 1550 |
+
:target: https://github.com/tqdm/tqdm/network
|
| 1551 |
+
.. |GitHub-Stars| image:: https://img.shields.io/github/stars/tqdm/tqdm.svg?logo=github&logoColor=white
|
| 1552 |
+
:target: https://github.com/tqdm/tqdm/stargazers
|
| 1553 |
+
.. |GitHub-Commits| image:: https://img.shields.io/github/commit-activity/y/tqdm/tqdm.svg?logo=git&logoColor=white
|
| 1554 |
+
:target: https://github.com/tqdm/tqdm/graphs/commit-activity
|
| 1555 |
+
.. |GitHub-Issues| image:: https://img.shields.io/github/issues-closed/tqdm/tqdm.svg?logo=github&logoColor=white
|
| 1556 |
+
:target: https://github.com/tqdm/tqdm/issues?q=
|
| 1557 |
+
.. |GitHub-PRs| image:: https://img.shields.io/github/issues-pr-closed/tqdm/tqdm.svg?logo=github&logoColor=white
|
| 1558 |
+
:target: https://github.com/tqdm/tqdm/pulls
|
| 1559 |
+
.. |GitHub-Contributions| image:: https://img.shields.io/github/contributors/tqdm/tqdm.svg?logo=github&logoColor=white
|
| 1560 |
+
:target: https://github.com/tqdm/tqdm/graphs/contributors
|
| 1561 |
+
.. |GitHub-Updated| image:: https://img.shields.io/github/last-commit/tqdm/tqdm/master.svg?logo=github&logoColor=white&label=pushed
|
| 1562 |
+
:target: https://github.com/tqdm/tqdm/pulse
|
| 1563 |
+
.. |git-fame| image:: https://git-fame.cdcl.ml/gh/tqdm/tqdm?min=5&w=1&M=1&C=1&excl=(png|gif|jpg)$&enum=1
|
| 1564 |
+
:alt: git-fame.cdcl.ml/gh/tqdm/tqdm
|
| 1565 |
+
:target: https://git-fame.cdcl.ml/gh/tqdm/tqdm?w=1&M=1&C=1&excl=(png|gif|jpg)$&enum=1
|
| 1566 |
+
.. |Gift-Casper| image:: https://img.shields.io/badge/sponsor-casper-ff69b4.svg
|
| 1567 |
+
:target: https://cdcl.ml/sponsor
|
| 1568 |
+
.. |Versions| image:: https://img.shields.io/pypi/v/tqdm.svg
|
| 1569 |
+
:target: https://tqdm.github.io/releases
|
| 1570 |
+
.. |PyPI-Downloads| image:: https://img.shields.io/pypi/dm/tqdm.svg?label=pypi%20downloads&logo=PyPI&logoColor=white
|
| 1571 |
+
:target: https://pepy.tech/project/tqdm
|
| 1572 |
+
.. |Py-Versions| image:: https://img.shields.io/pypi/pyversions/tqdm.svg?logo=python&logoColor=white
|
| 1573 |
+
:target: https://pypi.org/project/tqdm
|
| 1574 |
+
.. |Conda-Forge-Status| image:: https://img.shields.io/conda/v/conda-forge/tqdm.svg?label=conda-forge&logo=conda-forge
|
| 1575 |
+
:target: https://anaconda.org/conda-forge/tqdm
|
| 1576 |
+
.. |Snapcraft| image:: https://img.shields.io/badge/snap-install-82BEA0.svg?logo=snapcraft
|
| 1577 |
+
:target: https://snapcraft.io/tqdm
|
| 1578 |
+
.. |Docker| image:: https://img.shields.io/badge/docker-pull-blue.svg?logo=docker&logoColor=white
|
| 1579 |
+
:target: https://hub.docker.com/r/tqdm/tqdm
|
| 1580 |
+
.. |Libraries-Rank| image:: https://img.shields.io/librariesio/sourcerank/pypi/tqdm.svg?logo=koding&logoColor=white
|
| 1581 |
+
:target: https://libraries.io/pypi/tqdm
|
| 1582 |
+
.. |Libraries-Dependents| image:: https://img.shields.io/librariesio/dependent-repos/pypi/tqdm.svg?logo=koding&logoColor=white
|
| 1583 |
+
:target: https://github.com/tqdm/tqdm/network/dependents
|
| 1584 |
+
.. |OpenHub-Status| image:: https://www.openhub.net/p/tqdm/widgets/project_thin_badge?format=gif
|
| 1585 |
+
:target: https://www.openhub.net/p/tqdm?ref=Thin+badge
|
| 1586 |
+
.. |awesome-python| image:: https://awesome.re/mentioned-badge.svg
|
| 1587 |
+
:target: https://github.com/vinta/awesome-python
|
| 1588 |
+
.. |LICENCE| image:: https://img.shields.io/pypi/l/tqdm.svg
|
| 1589 |
+
:target: https://raw.githubusercontent.com/tqdm/tqdm/master/LICENCE
|
| 1590 |
+
.. |DOI| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.595120-blue.svg
|
| 1591 |
+
:target: https://doi.org/10.5281/zenodo.595120
|
| 1592 |
+
.. |colab-demo| image:: https://colab.research.google.com/assets/colab-badge.svg
|
| 1593 |
+
:target: https://colab.research.google.com/github/tqdm/tqdm/blob/master/DEMO.ipynb
|
| 1594 |
+
.. |binder-demo| image:: https://mybinder.org/badge_logo.svg
|
| 1595 |
+
:target: https://mybinder.org/v2/gh/tqdm/tqdm/master?filepath=DEMO.ipynb
|
| 1596 |
+
.. |Screenshot-Jupyter1| image:: https://tqdm.github.io/img/jupyter-1.gif
|
| 1597 |
+
.. |Screenshot-Jupyter2| image:: https://tqdm.github.io/img/jupyter-2.gif
|
| 1598 |
+
.. |Screenshot-Jupyter3| image:: https://tqdm.github.io/img/jupyter-3.gif
|
| 1599 |
+
.. |README-Hits| image:: https://cgi.cdcl.ml/hits?q=tqdm&style=social&r=https://github.com/tqdm/tqdm&l=https://tqdm.github.io/img/favicon.png&f=https://tqdm.github.io/img/logo.gif
|
| 1600 |
+
:target: https://cgi.cdcl.ml/hits?q=tqdm&a=plot&r=https://github.com/tqdm/tqdm&l=https://tqdm.github.io/img/favicon.png&f=https://tqdm.github.io/img/logo.gif&style=social
|
.cache/pip/http-v2/3/5/a/0/6/35a0615e0411edd59492c90e8f5cd0a1a0554d6f7d1dec5be2b30560
ADDED
|
Binary file (1.25 kB). View file
|
|
|
.cache/pip/http-v2/3/8/9/2/7/389270eb64d5d655add63491064e7e833611004a96c2fb8b19caa5fb.body
ADDED
|
@@ -0,0 +1,321 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Metadata-Version: 2.4
|
| 2 |
+
Name: colorlog
|
| 3 |
+
Version: 6.10.1
|
| 4 |
+
Summary: Add colours to the output of Python's logging module.
|
| 5 |
+
Home-page: https://github.com/borntyping/python-colorlog
|
| 6 |
+
Author: Sam Clements
|
| 7 |
+
Author-email: sam@borntyping.co.uk
|
| 8 |
+
License: MIT License
|
| 9 |
+
Classifier: Development Status :: 5 - Production/Stable
|
| 10 |
+
Classifier: Environment :: Console
|
| 11 |
+
Classifier: Intended Audience :: Developers
|
| 12 |
+
Classifier: License :: OSI Approved :: MIT License
|
| 13 |
+
Classifier: Operating System :: OS Independent
|
| 14 |
+
Classifier: Programming Language :: Python
|
| 15 |
+
Classifier: Programming Language :: Python :: 3
|
| 16 |
+
Classifier: Programming Language :: Python :: 3.6
|
| 17 |
+
Classifier: Programming Language :: Python :: 3.7
|
| 18 |
+
Classifier: Programming Language :: Python :: 3.8
|
| 19 |
+
Classifier: Programming Language :: Python :: 3.9
|
| 20 |
+
Classifier: Programming Language :: Python :: 3.10
|
| 21 |
+
Classifier: Programming Language :: Python :: 3.11
|
| 22 |
+
Classifier: Programming Language :: Python :: 3.12
|
| 23 |
+
Classifier: Programming Language :: Python :: 3.13
|
| 24 |
+
Classifier: Topic :: Terminals
|
| 25 |
+
Classifier: Topic :: Utilities
|
| 26 |
+
Requires-Python: >=3.6
|
| 27 |
+
Description-Content-Type: text/markdown
|
| 28 |
+
License-File: LICENSE
|
| 29 |
+
Requires-Dist: colorama; sys_platform == "win32"
|
| 30 |
+
Provides-Extra: development
|
| 31 |
+
Requires-Dist: black; extra == "development"
|
| 32 |
+
Requires-Dist: flake8; extra == "development"
|
| 33 |
+
Requires-Dist: mypy; extra == "development"
|
| 34 |
+
Requires-Dist: pytest; extra == "development"
|
| 35 |
+
Requires-Dist: types-colorama; extra == "development"
|
| 36 |
+
Dynamic: author
|
| 37 |
+
Dynamic: author-email
|
| 38 |
+
Dynamic: classifier
|
| 39 |
+
Dynamic: description
|
| 40 |
+
Dynamic: description-content-type
|
| 41 |
+
Dynamic: home-page
|
| 42 |
+
Dynamic: license
|
| 43 |
+
Dynamic: license-file
|
| 44 |
+
Dynamic: provides-extra
|
| 45 |
+
Dynamic: requires-python
|
| 46 |
+
Dynamic: summary
|
| 47 |
+
|
| 48 |
+
# Log formatting with colors!
|
| 49 |
+
|
| 50 |
+
[](https://pypi.org/project/colorlog/)
|
| 51 |
+
[](https://pypi.org/project/colorlog/)
|
| 52 |
+
|
| 53 |
+
Add colours to the output of Python's `logging` module.
|
| 54 |
+
|
| 55 |
+
* [Source on GitHub](https://github.com/borntyping/python-colorlog)
|
| 56 |
+
* [Packages on PyPI](https://pypi.org/pypi/colorlog/)
|
| 57 |
+
|
| 58 |
+
## Status
|
| 59 |
+
|
| 60 |
+
colorlog currently requires Python 3.6 or higher. Older versions (below 5.x.x)
|
| 61 |
+
support Python 2.6 and above.
|
| 62 |
+
|
| 63 |
+
* colorlog 6.x requires Python 3.6 or higher.
|
| 64 |
+
* colorlog 5.x is an interim version that will warn Python 2 users to downgrade.
|
| 65 |
+
* colorlog 4.x is the final version supporting Python 2.
|
| 66 |
+
|
| 67 |
+
[colorama] is included as a required dependency and initialised when using
|
| 68 |
+
colorlog on Windows.
|
| 69 |
+
|
| 70 |
+
This library is over a decade old and supported a wide set of Python versions
|
| 71 |
+
for most of its life, which has made it a difficult library to add new features
|
| 72 |
+
to. colorlog 6 may break backwards compatibility so that newer features
|
| 73 |
+
can be added more easily, but may still not accept all changes or feature
|
| 74 |
+
requests. colorlog 4 might accept essential bugfixes but should not be
|
| 75 |
+
considered actively maintained and will not accept any major changes or new
|
| 76 |
+
features.
|
| 77 |
+
|
| 78 |
+
## Installation
|
| 79 |
+
|
| 80 |
+
Install from PyPI with:
|
| 81 |
+
|
| 82 |
+
```bash
|
| 83 |
+
pip install colorlog
|
| 84 |
+
```
|
| 85 |
+
|
| 86 |
+
Several Linux distributions provide official packages ([Debian], [Arch], [Fedora],
|
| 87 |
+
[Gentoo], [OpenSuse] and [Ubuntu]), and others have user provided packages
|
| 88 |
+
([BSD ports], [Conda]).
|
| 89 |
+
|
| 90 |
+
## Usage
|
| 91 |
+
|
| 92 |
+
```python
|
| 93 |
+
import colorlog
|
| 94 |
+
|
| 95 |
+
handler = colorlog.StreamHandler()
|
| 96 |
+
handler.setFormatter(colorlog.ColoredFormatter(
|
| 97 |
+
'%(log_color)s%(levelname)s:%(name)s:%(message)s'))
|
| 98 |
+
|
| 99 |
+
logger = colorlog.getLogger('example')
|
| 100 |
+
logger.addHandler(handler)
|
| 101 |
+
```
|
| 102 |
+
|
| 103 |
+
The `ColoredFormatter` class takes several arguments:
|
| 104 |
+
|
| 105 |
+
- `format`: The format string used to output the message (required).
|
| 106 |
+
- `datefmt`: An optional date format passed to the base class. See [`logging.Formatter`][Formatter].
|
| 107 |
+
- `reset`: Implicitly adds a color reset code to the message output, unless the output already ends with one. Defaults to `True`.
|
| 108 |
+
- `log_colors`: A mapping of record level names to color names. The defaults can be found in `colorlog.default_log_colors`, or the below example.
|
| 109 |
+
- `secondary_log_colors`: A mapping of names to `log_colors` style mappings, defining additional colors that can be used in format strings. See below for an example.
|
| 110 |
+
- `style`: Available on Python 3.2 and above. See [`logging.Formatter`][Formatter].
|
| 111 |
+
|
| 112 |
+
Color escape codes can be selected based on the log records level, by adding
|
| 113 |
+
parameters to the format string:
|
| 114 |
+
|
| 115 |
+
- `log_color`: Return the color associated with the records level.
|
| 116 |
+
- `<name>_log_color`: Return another color based on the records level if the formatter has secondary colors configured (see `secondary_log_colors` below).
|
| 117 |
+
|
| 118 |
+
Multiple escape codes can be used at once by joining them with commas when
|
| 119 |
+
configuring the color for a log level (but can't be used directly in the format
|
| 120 |
+
string). For example, `black,bg_white` would use the escape codes for black
|
| 121 |
+
text on a white background.
|
| 122 |
+
|
| 123 |
+
The following escape codes are made available for use in the format string:
|
| 124 |
+
|
| 125 |
+
- `{color}`, `fg_{color}`, `bg_{color}`: Foreground and background colors.
|
| 126 |
+
- `bold`, `bold_{color}`, `fg_bold_{color}`, `bg_bold_{color}`: Bold/bright colors.
|
| 127 |
+
- `thin`, `thin_{color}`, `fg_thin_{color}`: Thin colors (terminal dependent).
|
| 128 |
+
- `reset`: Clear all formatting (both foreground and background colors).
|
| 129 |
+
|
| 130 |
+
The available color names are:
|
| 131 |
+
|
| 132 |
+
- `black`
|
| 133 |
+
- `red`
|
| 134 |
+
- `green`
|
| 135 |
+
- `yellow`
|
| 136 |
+
- `blue`,
|
| 137 |
+
- `purple`
|
| 138 |
+
- `cyan`
|
| 139 |
+
- `white`
|
| 140 |
+
|
| 141 |
+
You can also use "bright" colors. These aren't standard ANSI codes, and
|
| 142 |
+
support for these varies wildly across different terminals.
|
| 143 |
+
|
| 144 |
+
- `light_black`
|
| 145 |
+
- `light_red`
|
| 146 |
+
- `light_green`
|
| 147 |
+
- `light_yellow`
|
| 148 |
+
- `light_blue`
|
| 149 |
+
- `light_purple`
|
| 150 |
+
- `light_cyan`
|
| 151 |
+
- `light_white`
|
| 152 |
+
|
| 153 |
+
## Examples
|
| 154 |
+
|
| 155 |
+

|
| 156 |
+
|
| 157 |
+
The following code creates a `ColoredFormatter` for use in a logging setup,
|
| 158 |
+
using the default values for each argument.
|
| 159 |
+
|
| 160 |
+
```python
|
| 161 |
+
from colorlog import ColoredFormatter
|
| 162 |
+
|
| 163 |
+
formatter = ColoredFormatter(
|
| 164 |
+
"%(log_color)s%(levelname)-8s%(reset)s %(blue)s%(message)s",
|
| 165 |
+
datefmt=None,
|
| 166 |
+
reset=True,
|
| 167 |
+
log_colors={
|
| 168 |
+
'DEBUG': 'cyan',
|
| 169 |
+
'INFO': 'green',
|
| 170 |
+
'WARNING': 'yellow',
|
| 171 |
+
'ERROR': 'red',
|
| 172 |
+
'CRITICAL': 'red,bg_white',
|
| 173 |
+
},
|
| 174 |
+
secondary_log_colors={},
|
| 175 |
+
style='%'
|
| 176 |
+
)
|
| 177 |
+
```
|
| 178 |
+
|
| 179 |
+
### Using `secondary_log_colors`
|
| 180 |
+
|
| 181 |
+
Secondary log colors are a way to have more than one color that is selected
|
| 182 |
+
based on the log level. Each key in `secondary_log_colors` adds an attribute
|
| 183 |
+
that can be used in format strings (`message` becomes `message_log_color`), and
|
| 184 |
+
has a corresponding value that is identical in format to the `log_colors`
|
| 185 |
+
argument.
|
| 186 |
+
|
| 187 |
+
The following example highlights the level name using the default log colors,
|
| 188 |
+
and highlights the message in red for `error` and `critical` level log messages.
|
| 189 |
+
|
| 190 |
+
```python
|
| 191 |
+
from colorlog import ColoredFormatter
|
| 192 |
+
|
| 193 |
+
formatter = ColoredFormatter(
|
| 194 |
+
"%(log_color)s%(levelname)-8s%(reset)s %(message_log_color)s%(message)s",
|
| 195 |
+
secondary_log_colors={
|
| 196 |
+
'message': {
|
| 197 |
+
'ERROR': 'red',
|
| 198 |
+
'CRITICAL': 'red'
|
| 199 |
+
}
|
| 200 |
+
}
|
| 201 |
+
)
|
| 202 |
+
```
|
| 203 |
+
|
| 204 |
+
### With [`dictConfig`][dictConfig]
|
| 205 |
+
|
| 206 |
+
```python
|
| 207 |
+
logging.config.dictConfig({
|
| 208 |
+
'formatters': {
|
| 209 |
+
'colored': {
|
| 210 |
+
'()': 'colorlog.ColoredFormatter',
|
| 211 |
+
'format': "%(log_color)s%(levelname)-8s%(reset)s %(blue)s%(message)s"
|
| 212 |
+
}
|
| 213 |
+
}
|
| 214 |
+
})
|
| 215 |
+
```
|
| 216 |
+
|
| 217 |
+
A full example dictionary can be found in `tests/test_colorlog.py`.
|
| 218 |
+
|
| 219 |
+
### With [`fileConfig`][fileConfig]
|
| 220 |
+
|
| 221 |
+
```ini
|
| 222 |
+
...
|
| 223 |
+
|
| 224 |
+
[formatters]
|
| 225 |
+
keys=color
|
| 226 |
+
|
| 227 |
+
[formatter_color]
|
| 228 |
+
class=colorlog.ColoredFormatter
|
| 229 |
+
format=%(log_color)s%(levelname)-8s%(reset)s %(bg_blue)s[%(name)s]%(reset)s %(message)s from fileConfig
|
| 230 |
+
datefmt=%m-%d %H:%M:%S
|
| 231 |
+
```
|
| 232 |
+
|
| 233 |
+
An instance of ColoredFormatter created with those arguments will then be used
|
| 234 |
+
by any handlers that are configured to use the `color` formatter.
|
| 235 |
+
|
| 236 |
+
A full example configuration can be found in `tests/test_config.ini`.
|
| 237 |
+
|
| 238 |
+
### With custom log levels
|
| 239 |
+
|
| 240 |
+
ColoredFormatter will work with custom log levels added with
|
| 241 |
+
[`logging.addLevelName`][addLevelName]:
|
| 242 |
+
|
| 243 |
+
```python
|
| 244 |
+
import logging, colorlog
|
| 245 |
+
TRACE = 5
|
| 246 |
+
logging.addLevelName(TRACE, 'TRACE')
|
| 247 |
+
formatter = colorlog.ColoredFormatter(log_colors={'TRACE': 'yellow'})
|
| 248 |
+
handler = logging.StreamHandler()
|
| 249 |
+
handler.setFormatter(formatter)
|
| 250 |
+
logger = logging.getLogger('example')
|
| 251 |
+
logger.addHandler(handler)
|
| 252 |
+
logger.setLevel('TRACE')
|
| 253 |
+
logger.log(TRACE, 'a message using a custom level')
|
| 254 |
+
```
|
| 255 |
+
|
| 256 |
+
## Tests
|
| 257 |
+
|
| 258 |
+
Tests similar to the above examples are found in `tests/test_colorlog.py`.
|
| 259 |
+
|
| 260 |
+
## Status
|
| 261 |
+
|
| 262 |
+
colorlog is in maintenance mode. I try and ensure bugfixes are published,
|
| 263 |
+
but compatibility a wide set of Python versions makes this a difficult
|
| 264 |
+
codebase to add features to. Any changes that might break backwards
|
| 265 |
+
compatibility for existing users will not be considered.
|
| 266 |
+
|
| 267 |
+
## Alternatives
|
| 268 |
+
|
| 269 |
+
There are some more modern libraries for improving Python logging you may
|
| 270 |
+
find useful.
|
| 271 |
+
|
| 272 |
+
- [structlog]
|
| 273 |
+
- [jsonlog]
|
| 274 |
+
|
| 275 |
+
## Projects using colorlog
|
| 276 |
+
|
| 277 |
+
GitHub provides [a list of projects that depend on colorlog][dependents].
|
| 278 |
+
|
| 279 |
+
Some early adopters included [Errbot], [Pythran], and [zenlog].
|
| 280 |
+
|
| 281 |
+
## Licence
|
| 282 |
+
|
| 283 |
+
Copyright (c) 2012-2025 Sam Clements <sam@borntyping.co.uk>
|
| 284 |
+
|
| 285 |
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
| 286 |
+
this software and associated documentation files (the "Software"), to deal in
|
| 287 |
+
the Software without restriction, including without limitation the rights to
|
| 288 |
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
| 289 |
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
| 290 |
+
subject to the following conditions:
|
| 291 |
+
|
| 292 |
+
The above copyright notice and this permission notice shall be included in all
|
| 293 |
+
copies or substantial portions of the Software.
|
| 294 |
+
|
| 295 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 296 |
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
| 297 |
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
| 298 |
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
| 299 |
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
| 300 |
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
| 301 |
+
|
| 302 |
+
[dictConfig]: http://docs.python.org/3/library/logging.config.html#logging.config.dictConfig
|
| 303 |
+
[fileConfig]: http://docs.python.org/3/library/logging.config.html#logging.config.fileConfig
|
| 304 |
+
[addLevelName]: https://docs.python.org/3/library/logging.html#logging.addLevelName
|
| 305 |
+
[Formatter]: http://docs.python.org/3/library/logging.html#logging.Formatter
|
| 306 |
+
[tox]: http://tox.readthedocs.org/
|
| 307 |
+
[Arch]: https://archlinux.org/packages/extra/any/python-colorlog/
|
| 308 |
+
[BSD ports]: https://www.freshports.org/devel/py-colorlog/
|
| 309 |
+
[colorama]: https://pypi.python.org/pypi/colorama
|
| 310 |
+
[Conda]: https://anaconda.org/conda-forge/colorlog
|
| 311 |
+
[Debian]: [https://packages.debian.org/buster/python3-colorlog](https://packages.debian.org/buster/python3-colorlog)
|
| 312 |
+
[Errbot]: http://errbot.io/
|
| 313 |
+
[Fedora]: https://src.fedoraproject.org/rpms/python-colorlog
|
| 314 |
+
[Gentoo]: https://packages.gentoo.org/packages/dev-python/colorlog
|
| 315 |
+
[OpenSuse]: http://rpm.pbone.net/index.php3?stat=3&search=python-colorlog&srodzaj=3
|
| 316 |
+
[Pythran]: https://github.com/serge-sans-paille/pythran
|
| 317 |
+
[Ubuntu]: https://launchpad.net/python-colorlog
|
| 318 |
+
[zenlog]: https://github.com/ManufacturaInd/python-zenlog
|
| 319 |
+
[structlog]: https://www.structlog.org/en/stable/
|
| 320 |
+
[jsonlog]: https://github.com/borntyping/jsonlog
|
| 321 |
+
[dependents]: https://github.com/borntyping/python-colorlog/network/dependents?package_id=UGFja2FnZS01MDk3NDcyMQ%3D%3D
|
.cache/pip/http-v2/4/5/2/4/1/45241d61b1606b84c3825a9119b750e7cd16e5fac504d31f79203a8e
ADDED
|
Binary file (1.3 kB). View file
|
|
|
.cache/pip/http-v2/4/5/2/4/1/45241d61b1606b84c3825a9119b750e7cd16e5fac504d31f79203a8e.body
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Metadata-Version: 2.4
|
| 2 |
+
Name: click
|
| 3 |
+
Version: 8.4.2
|
| 4 |
+
Summary: Composable command line interface toolkit
|
| 5 |
+
Maintainer-email: Pallets <contact@palletsprojects.com>
|
| 6 |
+
Requires-Python: >=3.10
|
| 7 |
+
Description-Content-Type: text/markdown
|
| 8 |
+
License-Expression: BSD-3-Clause
|
| 9 |
+
Classifier: Development Status :: 5 - Production/Stable
|
| 10 |
+
Classifier: Intended Audience :: Developers
|
| 11 |
+
Classifier: Operating System :: OS Independent
|
| 12 |
+
Classifier: Programming Language :: Python
|
| 13 |
+
Classifier: Typing :: Typed
|
| 14 |
+
License-File: LICENSE.txt
|
| 15 |
+
Requires-Dist: colorama; platform_system == 'Windows'
|
| 16 |
+
Project-URL: Changes, https://click.palletsprojects.com/page/changes/
|
| 17 |
+
Project-URL: Chat, https://discord.gg/pallets
|
| 18 |
+
Project-URL: Documentation, https://click.palletsprojects.com/
|
| 19 |
+
Project-URL: Donate, https://palletsprojects.com/donate
|
| 20 |
+
Project-URL: Source, https://github.com/pallets/click/
|
| 21 |
+
|
| 22 |
+
<div align="center"><img src="https://raw.githubusercontent.com/pallets/click/refs/heads/stable/docs/_static/click-name.svg" alt="" height="150"></div>
|
| 23 |
+
|
| 24 |
+
# Click
|
| 25 |
+
|
| 26 |
+
Click is a Python package for creating beautiful command line interfaces
|
| 27 |
+
in a composable way with as little code as necessary. It's the "Command
|
| 28 |
+
Line Interface Creation Kit". It's highly configurable but comes with
|
| 29 |
+
sensible defaults out of the box.
|
| 30 |
+
|
| 31 |
+
It aims to make the process of writing command line tools quick and fun
|
| 32 |
+
while also preventing any frustration caused by the inability to
|
| 33 |
+
implement an intended CLI API.
|
| 34 |
+
|
| 35 |
+
Click in three points:
|
| 36 |
+
|
| 37 |
+
- Arbitrary nesting of commands
|
| 38 |
+
- Automatic help page generation
|
| 39 |
+
- Supports lazy loading of subcommands at runtime
|
| 40 |
+
|
| 41 |
+
|
| 42 |
+
## A Simple Example
|
| 43 |
+
|
| 44 |
+
```python
|
| 45 |
+
import click
|
| 46 |
+
|
| 47 |
+
@click.command()
|
| 48 |
+
@click.option("--count", default=1, help="Number of greetings.")
|
| 49 |
+
@click.option("--name", prompt="Your name", help="The person to greet.")
|
| 50 |
+
def hello(count, name):
|
| 51 |
+
"""Simple program that greets NAME for a total of COUNT times."""
|
| 52 |
+
for _ in range(count):
|
| 53 |
+
click.echo(f"Hello, {name}!")
|
| 54 |
+
|
| 55 |
+
if __name__ == '__main__':
|
| 56 |
+
hello()
|
| 57 |
+
```
|
| 58 |
+
|
| 59 |
+
```
|
| 60 |
+
$ python hello.py --count=3
|
| 61 |
+
Your name: Click
|
| 62 |
+
Hello, Click!
|
| 63 |
+
Hello, Click!
|
| 64 |
+
Hello, Click!
|
| 65 |
+
```
|
| 66 |
+
|
| 67 |
+
|
| 68 |
+
## Donate
|
| 69 |
+
|
| 70 |
+
The Pallets organization develops and supports Click and other popular
|
| 71 |
+
packages. In order to grow the community of contributors and users, and
|
| 72 |
+
allow the maintainers to devote more time to the projects, [please
|
| 73 |
+
donate today][].
|
| 74 |
+
|
| 75 |
+
[please donate today]: https://palletsprojects.com/donate
|
| 76 |
+
|
| 77 |
+
## Contributing
|
| 78 |
+
|
| 79 |
+
See our [detailed contributing documentation][contrib] for many ways to
|
| 80 |
+
contribute, including reporting issues, requesting features, asking or answering
|
| 81 |
+
questions, and making PRs.
|
| 82 |
+
|
| 83 |
+
[contrib]: https://palletsprojects.com/contributing/
|
| 84 |
+
|
.cache/pip/http-v2/4/a/5/b/6/4a5b6f0d76201de4cfd4884f5e95617a1848cf81c8357be4d12cbf6a
ADDED
|
Binary file (1.27 kB). View file
|
|
|
.cache/pip/http-v2/4/a/5/b/6/4a5b6f0d76201de4cfd4884f5e95617a1848cf81c8357be4d12cbf6a.body
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Metadata-Version: 2.1
|
| 2 |
+
Name: openpyxl
|
| 3 |
+
Version: 3.1.5
|
| 4 |
+
Summary: A Python library to read/write Excel 2010 xlsx/xlsm files
|
| 5 |
+
Home-page: https://openpyxl.readthedocs.io
|
| 6 |
+
Author: See AUTHORS
|
| 7 |
+
Author-email: charlie.clark@clark-consulting.eu
|
| 8 |
+
License: MIT
|
| 9 |
+
Project-URL: Documentation, https://openpyxl.readthedocs.io/en/stable/
|
| 10 |
+
Project-URL: Source, https://foss.heptapod.net/openpyxl/openpyxl
|
| 11 |
+
Project-URL: Tracker, https://foss.heptapod.net/openpyxl/openpyxl/-/issues
|
| 12 |
+
Classifier: Development Status :: 5 - Production/Stable
|
| 13 |
+
Classifier: Operating System :: MacOS :: MacOS X
|
| 14 |
+
Classifier: Operating System :: Microsoft :: Windows
|
| 15 |
+
Classifier: Operating System :: POSIX
|
| 16 |
+
Classifier: License :: OSI Approved :: MIT License
|
| 17 |
+
Classifier: Programming Language :: Python
|
| 18 |
+
Classifier: Programming Language :: Python :: 3.6
|
| 19 |
+
Classifier: Programming Language :: Python :: 3.7
|
| 20 |
+
Classifier: Programming Language :: Python :: 3.8
|
| 21 |
+
Classifier: Programming Language :: Python :: 3.9
|
| 22 |
+
Classifier: Programming Language :: Python :: 3.10
|
| 23 |
+
Classifier: Programming Language :: Python :: 3.11
|
| 24 |
+
Requires-Python: >=3.8
|
| 25 |
+
License-File: LICENCE.rst
|
| 26 |
+
Requires-Dist: et-xmlfile
|
| 27 |
+
|
| 28 |
+
.. image:: https://coveralls.io/repos/bitbucket/openpyxl/openpyxl/badge.svg?branch=default
|
| 29 |
+
:target: https://coveralls.io/bitbucket/openpyxl/openpyxl?branch=default
|
| 30 |
+
:alt: coverage status
|
| 31 |
+
|
| 32 |
+
Introduction
|
| 33 |
+
------------
|
| 34 |
+
|
| 35 |
+
openpyxl is a Python library to read/write Excel 2010 xlsx/xlsm/xltx/xltm files.
|
| 36 |
+
|
| 37 |
+
It was born from lack of existing library to read/write natively from Python
|
| 38 |
+
the Office Open XML format.
|
| 39 |
+
|
| 40 |
+
All kudos to the PHPExcel team as openpyxl was initially based on PHPExcel.
|
| 41 |
+
|
| 42 |
+
|
| 43 |
+
Security
|
| 44 |
+
--------
|
| 45 |
+
|
| 46 |
+
By default openpyxl does not guard against quadratic blowup or billion laughs
|
| 47 |
+
xml attacks. To guard against these attacks install defusedxml.
|
| 48 |
+
|
| 49 |
+
Mailing List
|
| 50 |
+
------------
|
| 51 |
+
|
| 52 |
+
The user list can be found on http://groups.google.com/group/openpyxl-users
|
| 53 |
+
|
| 54 |
+
|
| 55 |
+
Sample code::
|
| 56 |
+
|
| 57 |
+
from openpyxl import Workbook
|
| 58 |
+
wb = Workbook()
|
| 59 |
+
|
| 60 |
+
# grab the active worksheet
|
| 61 |
+
ws = wb.active
|
| 62 |
+
|
| 63 |
+
# Data can be assigned directly to cells
|
| 64 |
+
ws['A1'] = 42
|
| 65 |
+
|
| 66 |
+
# Rows can also be appended
|
| 67 |
+
ws.append([1, 2, 3])
|
| 68 |
+
|
| 69 |
+
# Python types will automatically be converted
|
| 70 |
+
import datetime
|
| 71 |
+
ws['A2'] = datetime.datetime.now()
|
| 72 |
+
|
| 73 |
+
# Save the file
|
| 74 |
+
wb.save("sample.xlsx")
|
| 75 |
+
|
| 76 |
+
|
| 77 |
+
Documentation
|
| 78 |
+
-------------
|
| 79 |
+
|
| 80 |
+
The documentation is at: https://openpyxl.readthedocs.io
|
| 81 |
+
|
| 82 |
+
* installation methods
|
| 83 |
+
* code examples
|
| 84 |
+
* instructions for contributing
|
| 85 |
+
|
| 86 |
+
Release notes: https://openpyxl.readthedocs.io/en/stable/changes.html
|
.cache/pip/http-v2/4/d/c/8/d/4dc8d567db4bc55c0684404c85a6b4572f87a99306be24cab65fbfae
ADDED
|
Binary file (1.89 kB). View file
|
|
|
.cache/pip/http-v2/4/d/c/8/d/4dc8d567db4bc55c0684404c85a6b4572f87a99306be24cab65fbfae.body
ADDED
|
Binary file (16.2 kB). View file
|
|
|
.cache/pip/http-v2/5/9/1/a/0/591a0a7ea47d81cffb332bf5e1460e560ce743822558c6f345314d4b
ADDED
|
Binary file (1.23 kB). View file
|
|
|
.cache/pip/http-v2/5/9/1/a/0/591a0a7ea47d81cffb332bf5e1460e560ce743822558c6f345314d4b.body
ADDED
|
Binary file (18.1 kB). View file
|
|
|
.cache/pip/http-v2/5/e/c/8/b/5ec8b58bc827caa12672b72c08527dbd1c5456edeea815f1e76cb526
ADDED
|
Binary file (1.2 kB). View file
|
|
|
.cache/pip/http-v2/6/4/c/f/c/64cfc03e83f9fad4049b1d2a1d785c9273270a4ab9788b538f5054e3
ADDED
|
Binary file (1.9 kB). View file
|
|
|
.cache/pip/http-v2/6/5/1/e/5/651e58859e8db8c99b9e7068d03984cfd4577518ff0e021c717afbf4
ADDED
|
Binary file (1.27 kB). View file
|
|
|
.cache/pip/http-v2/6/5/1/e/5/651e58859e8db8c99b9e7068d03984cfd4577518ff0e021c717afbf4.body
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Metadata-Version: 2.1
|
| 2 |
+
Name: cycler
|
| 3 |
+
Version: 0.12.1
|
| 4 |
+
Summary: Composable style cycles
|
| 5 |
+
Author-email: Thomas A Caswell <matplotlib-users@python.org>
|
| 6 |
+
License: Copyright (c) 2015, matplotlib project
|
| 7 |
+
All rights reserved.
|
| 8 |
+
|
| 9 |
+
Redistribution and use in source and binary forms, with or without
|
| 10 |
+
modification, are permitted provided that the following conditions are met:
|
| 11 |
+
|
| 12 |
+
* Redistributions of source code must retain the above copyright notice, this
|
| 13 |
+
list of conditions and the following disclaimer.
|
| 14 |
+
|
| 15 |
+
* Redistributions in binary form must reproduce the above copyright notice,
|
| 16 |
+
this list of conditions and the following disclaimer in the documentation
|
| 17 |
+
and/or other materials provided with the distribution.
|
| 18 |
+
|
| 19 |
+
* Neither the name of the matplotlib project nor the names of its
|
| 20 |
+
contributors may be used to endorse or promote products derived from
|
| 21 |
+
this software without specific prior written permission.
|
| 22 |
+
|
| 23 |
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
| 24 |
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
| 25 |
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
| 26 |
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
| 27 |
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
| 28 |
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
| 29 |
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
| 30 |
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
| 31 |
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
| 32 |
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
| 33 |
+
Project-URL: homepage, https://matplotlib.org/cycler/
|
| 34 |
+
Project-URL: repository, https://github.com/matplotlib/cycler
|
| 35 |
+
Keywords: cycle kwargs
|
| 36 |
+
Classifier: License :: OSI Approved :: BSD License
|
| 37 |
+
Classifier: Development Status :: 4 - Beta
|
| 38 |
+
Classifier: Programming Language :: Python :: 3
|
| 39 |
+
Classifier: Programming Language :: Python :: 3.8
|
| 40 |
+
Classifier: Programming Language :: Python :: 3.9
|
| 41 |
+
Classifier: Programming Language :: Python :: 3.10
|
| 42 |
+
Classifier: Programming Language :: Python :: 3.11
|
| 43 |
+
Classifier: Programming Language :: Python :: 3.12
|
| 44 |
+
Classifier: Programming Language :: Python :: 3 :: Only
|
| 45 |
+
Requires-Python: >=3.8
|
| 46 |
+
Description-Content-Type: text/x-rst
|
| 47 |
+
License-File: LICENSE
|
| 48 |
+
Provides-Extra: docs
|
| 49 |
+
Requires-Dist: ipython ; extra == 'docs'
|
| 50 |
+
Requires-Dist: matplotlib ; extra == 'docs'
|
| 51 |
+
Requires-Dist: numpydoc ; extra == 'docs'
|
| 52 |
+
Requires-Dist: sphinx ; extra == 'docs'
|
| 53 |
+
Provides-Extra: tests
|
| 54 |
+
Requires-Dist: pytest ; extra == 'tests'
|
| 55 |
+
Requires-Dist: pytest-cov ; extra == 'tests'
|
| 56 |
+
Requires-Dist: pytest-xdist ; extra == 'tests'
|
| 57 |
+
|
| 58 |
+
|PyPi|_ |Conda|_ |Supported Python versions|_ |GitHub Actions|_ |Codecov|_
|
| 59 |
+
|
| 60 |
+
.. |PyPi| image:: https://img.shields.io/pypi/v/cycler.svg?style=flat
|
| 61 |
+
.. _PyPi: https://pypi.python.org/pypi/cycler
|
| 62 |
+
|
| 63 |
+
.. |Conda| image:: https://img.shields.io/conda/v/conda-forge/cycler
|
| 64 |
+
.. _Conda: https://anaconda.org/conda-forge/cycler
|
| 65 |
+
|
| 66 |
+
.. |Supported Python versions| image:: https://img.shields.io/pypi/pyversions/cycler.svg
|
| 67 |
+
.. _Supported Python versions: https://pypi.python.org/pypi/cycler
|
| 68 |
+
|
| 69 |
+
.. |GitHub Actions| image:: https://github.com/matplotlib/cycler/actions/workflows/tests.yml/badge.svg
|
| 70 |
+
.. _GitHub Actions: https://github.com/matplotlib/cycler/actions
|
| 71 |
+
|
| 72 |
+
.. |Codecov| image:: https://codecov.io/github/matplotlib/cycler/badge.svg?branch=main&service=github
|
| 73 |
+
.. _Codecov: https://codecov.io/github/matplotlib/cycler?branch=main
|
| 74 |
+
|
| 75 |
+
cycler: composable cycles
|
| 76 |
+
=========================
|
| 77 |
+
|
| 78 |
+
Docs: https://matplotlib.org/cycler/
|
.cache/pip/http-v2/6/6/e/c/7/66ec76a7b6ed4081044f5c7821af293b63c17bc2ac523ff93d5ca7d5
ADDED
|
Binary file (1.9 kB). View file
|
|
|
.cache/pip/http-v2/6/8/0/d/4/680d4dd80dc6a3d2df9b9478dfcc8e81e0e4f130e154a3268b98b877
ADDED
|
Binary file (1.89 kB). View file
|
|
|
.cache/pip/http-v2/6/9/2/f/2/692f2804b6b8394551c77857160a003c2da933441522c71fd20e4ca4
ADDED
|
Binary file (1.26 kB). View file
|
|
|
.cache/pip/http-v2/6/b/5/3/a/6b53a9dd0e4fce887cc28c1a921aa1befe8c1a82e6c213d2542d2acb
ADDED
|
Binary file (1.89 kB). View file
|
|
|
.cache/pip/http-v2/6/b/5/3/a/6b53a9dd0e4fce887cc28c1a921aa1befe8c1a82e6c213d2542d2acb.body
ADDED
|
Binary file (14.8 kB). View file
|
|
|
.cache/pip/http-v2/6/c/6/e/e/6c6eeaf6757edbde690577822daacaba826c2b12ce67b57b33e8021d
ADDED
|
Binary file (1.23 kB). View file
|
|
|
.cache/pip/http-v2/6/c/6/e/e/6c6eeaf6757edbde690577822daacaba826c2b12ce67b57b33e8021d.body
ADDED
|
Binary file (8.32 kB). View file
|
|
|
.cache/pip/http-v2/7/2/8/a/2/728a2f33f382f4dacf08f6df77aad6f3d889f819ba4fa3efad5ec7e4
ADDED
|
Binary file (1.89 kB). View file
|
|
|
.cache/pip/http-v2/7/5/c/7/6/75c76ba3da983fc745a6549a0de110dcd624d42b682204260c21f535
ADDED
|
Binary file (1.2 kB). View file
|
|
|
.cache/pip/http-v2/7/9/2/1/a/7921ac3318a5cdb592026cc26a94f7a2c1e1f7d3a1dc1e3857fd49f1
ADDED
|
Binary file (1.89 kB). View file
|
|
|
.cache/pip/http-v2/7/9/2/1/a/7921ac3318a5cdb592026cc26a94f7a2c1e1f7d3a1dc1e3857fd49f1.body
ADDED
|
Binary file (1.94 kB). View file
|
|
|
.cache/pip/http-v2/7/f/0/e/c/7f0ec35e0c3a1faba9aada2b4b15e64482162fc43af0f7193ee83003
ADDED
|
Binary file (1.2 kB). View file
|
|
|
.cache/pip/http-v2/8/1/8/8/f/8188f9db6169e57bb653240cc02c629488d0d899420b0725db0f7e4a
ADDED
|
Binary file (1.2 kB). View file
|
|
|
.cache/pip/http-v2/8/a/c/4/d/8ac4d14dc45e27d21da49fb515570b6f875b78707de9b08ce1088d1b
ADDED
|
Binary file (1.89 kB). View file
|
|
|
.cache/pip/http-v2/8/a/c/4/d/8ac4d14dc45e27d21da49fb515570b6f875b78707de9b08ce1088d1b.body
ADDED
|
Binary file (17.3 kB). View file
|
|
|
.cache/pip/http-v2/8/e/0/9/f/8e09f241e363fdfdfd9cade803fe7df10d489fd9430647a4b0b3c719
ADDED
|
Binary file (1.27 kB). View file
|
|
|
.cache/pip/http-v2/8/e/0/9/f/8e09f241e363fdfdfd9cade803fe7df10d489fd9430647a4b0b3c719.body
ADDED
|
@@ -0,0 +1,1383 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Metadata-Version: 2.1
|
| 2 |
+
Name: pandas
|
| 3 |
+
Version: 3.0.3
|
| 4 |
+
Summary: Powerful data structures for data analysis, time series, and statistics
|
| 5 |
+
Author-Email: The Pandas Development Team <pandas-dev@python.org>
|
| 6 |
+
License: BSD 3-Clause License
|
| 7 |
+
|
| 8 |
+
Copyright (c) 2008-2011, AQR Capital Management, LLC, Lambda Foundry, Inc. and PyData Development Team
|
| 9 |
+
All rights reserved.
|
| 10 |
+
|
| 11 |
+
Copyright (c) 2011-2026, Open source contributors.
|
| 12 |
+
|
| 13 |
+
Redistribution and use in source and binary forms, with or without
|
| 14 |
+
modification, are permitted provided that the following conditions are met:
|
| 15 |
+
|
| 16 |
+
* Redistributions of source code must retain the above copyright notice, this
|
| 17 |
+
list of conditions and the following disclaimer.
|
| 18 |
+
|
| 19 |
+
* Redistributions in binary form must reproduce the above copyright notice,
|
| 20 |
+
this list of conditions and the following disclaimer in the documentation
|
| 21 |
+
and/or other materials provided with the distribution.
|
| 22 |
+
|
| 23 |
+
* Neither the name of the copyright holder nor the names of its
|
| 24 |
+
contributors may be used to endorse or promote products derived from
|
| 25 |
+
this software without specific prior written permission.
|
| 26 |
+
|
| 27 |
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
| 28 |
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
| 29 |
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
| 30 |
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
| 31 |
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
| 32 |
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
| 33 |
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
| 34 |
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
| 35 |
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
| 36 |
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
| 37 |
+
Copyright (c) 2010-2019 Keith Goodman
|
| 38 |
+
Copyright (c) 2019 Bottleneck Developers
|
| 39 |
+
All rights reserved.
|
| 40 |
+
|
| 41 |
+
Redistribution and use in source and binary forms, with or without
|
| 42 |
+
modification, are permitted provided that the following conditions are met:
|
| 43 |
+
|
| 44 |
+
* Redistributions of source code must retain the above copyright notice,
|
| 45 |
+
this list of conditions and the following disclaimer.
|
| 46 |
+
|
| 47 |
+
* Redistributions in binary form must reproduce the above copyright
|
| 48 |
+
notice, this list of conditions and the following disclaimer in the
|
| 49 |
+
documentation and/or other materials provided with the distribution.
|
| 50 |
+
|
| 51 |
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
| 52 |
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
| 53 |
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
| 54 |
+
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
| 55 |
+
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
| 56 |
+
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
| 57 |
+
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
| 58 |
+
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
| 59 |
+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
| 60 |
+
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
| 61 |
+
POSSIBILITY OF SUCH DAMAGE.Copyright 2017- Paul Ganssle <paul@ganssle.io>
|
| 62 |
+
Copyright 2017- dateutil contributors (see AUTHORS file)
|
| 63 |
+
|
| 64 |
+
Licensed under the Apache License, Version 2.0 (the "License");
|
| 65 |
+
you may not use this file except in compliance with the License.
|
| 66 |
+
You may obtain a copy of the License at
|
| 67 |
+
|
| 68 |
+
http://www.apache.org/licenses/LICENSE-2.0
|
| 69 |
+
|
| 70 |
+
Unless required by applicable law or agreed to in writing, software
|
| 71 |
+
distributed under the License is distributed on an "AS IS" BASIS,
|
| 72 |
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
| 73 |
+
See the License for the specific language governing permissions and
|
| 74 |
+
limitations under the License.
|
| 75 |
+
|
| 76 |
+
The above license applies to all contributions after 2017-12-01, as well as
|
| 77 |
+
all contributions that have been re-licensed (see AUTHORS file for the list of
|
| 78 |
+
contributors who have re-licensed their code).
|
| 79 |
+
--------------------------------------------------------------------------------
|
| 80 |
+
dateutil - Extensions to the standard Python datetime module.
|
| 81 |
+
|
| 82 |
+
Copyright (c) 2003-2011 - Gustavo Niemeyer <gustavo@niemeyer.net>
|
| 83 |
+
Copyright (c) 2012-2014 - Tomi Pieviläinen <tomi.pievilainen@iki.fi>
|
| 84 |
+
Copyright (c) 2014-2016 - Yaron de Leeuw <me@jarondl.net>
|
| 85 |
+
Copyright (c) 2015- - Paul Ganssle <paul@ganssle.io>
|
| 86 |
+
Copyright (c) 2015- - dateutil contributors (see AUTHORS file)
|
| 87 |
+
|
| 88 |
+
All rights reserved.
|
| 89 |
+
|
| 90 |
+
Redistribution and use in source and binary forms, with or without
|
| 91 |
+
modification, are permitted provided that the following conditions are met:
|
| 92 |
+
|
| 93 |
+
* Redistributions of source code must retain the above copyright notice,
|
| 94 |
+
this list of conditions and the following disclaimer.
|
| 95 |
+
* Redistributions in binary form must reproduce the above copyright notice,
|
| 96 |
+
this list of conditions and the following disclaimer in the documentation
|
| 97 |
+
and/or other materials provided with the distribution.
|
| 98 |
+
* Neither the name of the copyright holder nor the names of its
|
| 99 |
+
contributors may be used to endorse or promote products derived from
|
| 100 |
+
this software without specific prior written permission.
|
| 101 |
+
|
| 102 |
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
| 103 |
+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
| 104 |
+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
| 105 |
+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
|
| 106 |
+
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
| 107 |
+
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
| 108 |
+
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
| 109 |
+
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
| 110 |
+
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
| 111 |
+
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
| 112 |
+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
| 113 |
+
|
| 114 |
+
The above BSD License Applies to all code, even that also covered by Apache 2.0.# MIT License
|
| 115 |
+
|
| 116 |
+
Copyright (c) 2019 Hadley Wickham; RStudio; and Evan Miller
|
| 117 |
+
|
| 118 |
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
| 119 |
+
of this software and associated documentation files (the "Software"), to deal
|
| 120 |
+
in the Software without restriction, including without limitation the rights
|
| 121 |
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
| 122 |
+
copies of the Software, and to permit persons to whom the Software is
|
| 123 |
+
furnished to do so, subject to the following conditions:
|
| 124 |
+
|
| 125 |
+
The above copyright notice and this permission notice shall be included in all
|
| 126 |
+
copies or substantial portions of the Software.
|
| 127 |
+
|
| 128 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 129 |
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| 130 |
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| 131 |
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| 132 |
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
| 133 |
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
| 134 |
+
SOFTWARE.
|
| 135 |
+
Based on http://opensource.org/licenses/MIT
|
| 136 |
+
|
| 137 |
+
This is a template. Complete and ship as file LICENSE the following 2
|
| 138 |
+
lines (only)
|
| 139 |
+
|
| 140 |
+
YEAR:
|
| 141 |
+
COPYRIGHT HOLDER:
|
| 142 |
+
|
| 143 |
+
and specify as
|
| 144 |
+
|
| 145 |
+
License: MIT + file LICENSE
|
| 146 |
+
|
| 147 |
+
Copyright (c) <YEAR>, <COPYRIGHT HOLDER>
|
| 148 |
+
|
| 149 |
+
Permission is hereby granted, free of charge, to any person obtaining
|
| 150 |
+
a copy of this software and associated documentation files (the
|
| 151 |
+
"Software"), to deal in the Software without restriction, including
|
| 152 |
+
without limitation the rights to use, copy, modify, merge, publish,
|
| 153 |
+
distribute, sublicense, and/or sell copies of the Software, and to
|
| 154 |
+
permit persons to whom the Software is furnished to do so, subject to
|
| 155 |
+
the following conditions:
|
| 156 |
+
|
| 157 |
+
The above copyright notice and this permission notice shall be
|
| 158 |
+
included in all copies or substantial portions of the Software.
|
| 159 |
+
|
| 160 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
| 161 |
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
| 162 |
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
| 163 |
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
| 164 |
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
| 165 |
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
| 166 |
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
| 167 |
+
The MIT License
|
| 168 |
+
|
| 169 |
+
Copyright (c) 2008- Attractive Chaos <attractor@live.co.uk>
|
| 170 |
+
|
| 171 |
+
Permission is hereby granted, free of charge, to any person obtaining
|
| 172 |
+
a copy of this software and associated documentation files (the
|
| 173 |
+
"Software"), to deal in the Software without restriction, including
|
| 174 |
+
without limitation the rights to use, copy, modify, merge, publish,
|
| 175 |
+
distribute, sublicense, and/or sell copies of the Software, and to
|
| 176 |
+
permit persons to whom the Software is furnished to do so, subject to
|
| 177 |
+
the following conditions:
|
| 178 |
+
|
| 179 |
+
The above copyright notice and this permission notice shall be
|
| 180 |
+
included in all copies or substantial portions of the Software.
|
| 181 |
+
|
| 182 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
| 183 |
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
| 184 |
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
| 185 |
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
| 186 |
+
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
| 187 |
+
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
| 188 |
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
| 189 |
+
SOFTWARE.musl as a whole is licensed under the following standard MIT license:
|
| 190 |
+
|
| 191 |
+
----------------------------------------------------------------------
|
| 192 |
+
Copyright © 2005-2020 Rich Felker, et al.
|
| 193 |
+
|
| 194 |
+
Permission is hereby granted, free of charge, to any person obtaining
|
| 195 |
+
a copy of this software and associated documentation files (the
|
| 196 |
+
"Software"), to deal in the Software without restriction, including
|
| 197 |
+
without limitation the rights to use, copy, modify, merge, publish,
|
| 198 |
+
distribute, sublicense, and/or sell copies of the Software, and to
|
| 199 |
+
permit persons to whom the Software is furnished to do so, subject to
|
| 200 |
+
the following conditions:
|
| 201 |
+
|
| 202 |
+
The above copyright notice and this permission notice shall be
|
| 203 |
+
included in all copies or substantial portions of the Software.
|
| 204 |
+
|
| 205 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
| 206 |
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
| 207 |
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
| 208 |
+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
| 209 |
+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
| 210 |
+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
| 211 |
+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
| 212 |
+
----------------------------------------------------------------------
|
| 213 |
+
|
| 214 |
+
Authors/contributors include:
|
| 215 |
+
|
| 216 |
+
A. Wilcox
|
| 217 |
+
Ada Worcester
|
| 218 |
+
Alex Dowad
|
| 219 |
+
Alex Suykov
|
| 220 |
+
Alexander Monakov
|
| 221 |
+
Andre McCurdy
|
| 222 |
+
Andrew Kelley
|
| 223 |
+
Anthony G. Basile
|
| 224 |
+
Aric Belsito
|
| 225 |
+
Arvid Picciani
|
| 226 |
+
Bartosz Brachaczek
|
| 227 |
+
Benjamin Peterson
|
| 228 |
+
Bobby Bingham
|
| 229 |
+
Boris Brezillon
|
| 230 |
+
Brent Cook
|
| 231 |
+
Chris Spiegel
|
| 232 |
+
Clément Vasseur
|
| 233 |
+
Daniel Micay
|
| 234 |
+
Daniel Sabogal
|
| 235 |
+
Daurnimator
|
| 236 |
+
David Carlier
|
| 237 |
+
David Edelsohn
|
| 238 |
+
Denys Vlasenko
|
| 239 |
+
Dmitry Ivanov
|
| 240 |
+
Dmitry V. Levin
|
| 241 |
+
Drew DeVault
|
| 242 |
+
Emil Renner Berthing
|
| 243 |
+
Fangrui Song
|
| 244 |
+
Felix Fietkau
|
| 245 |
+
Felix Janda
|
| 246 |
+
Gianluca Anzolin
|
| 247 |
+
Hauke Mehrtens
|
| 248 |
+
He X
|
| 249 |
+
Hiltjo Posthuma
|
| 250 |
+
Isaac Dunham
|
| 251 |
+
Jaydeep Patil
|
| 252 |
+
Jens Gustedt
|
| 253 |
+
Jeremy Huntwork
|
| 254 |
+
Jo-Philipp Wich
|
| 255 |
+
Joakim Sindholt
|
| 256 |
+
John Spencer
|
| 257 |
+
Julien Ramseier
|
| 258 |
+
Justin Cormack
|
| 259 |
+
Kaarle Ritvanen
|
| 260 |
+
Khem Raj
|
| 261 |
+
Kylie McClain
|
| 262 |
+
Leah Neukirchen
|
| 263 |
+
Luca Barbato
|
| 264 |
+
Luka Perkov
|
| 265 |
+
M Farkas-Dyck (Strake)
|
| 266 |
+
Mahesh Bodapati
|
| 267 |
+
Markus Wichmann
|
| 268 |
+
Masanori Ogino
|
| 269 |
+
Michael Clark
|
| 270 |
+
Michael Forney
|
| 271 |
+
Mikhail Kremnyov
|
| 272 |
+
Natanael Copa
|
| 273 |
+
Nicholas J. Kain
|
| 274 |
+
orc
|
| 275 |
+
Pascal Cuoq
|
| 276 |
+
Patrick Oppenlander
|
| 277 |
+
Petr Hosek
|
| 278 |
+
Petr Skocik
|
| 279 |
+
Pierre Carrier
|
| 280 |
+
Reini Urban
|
| 281 |
+
Rich Felker
|
| 282 |
+
Richard Pennington
|
| 283 |
+
Ryan Fairfax
|
| 284 |
+
Samuel Holland
|
| 285 |
+
Segev Finer
|
| 286 |
+
Shiz
|
| 287 |
+
sin
|
| 288 |
+
Solar Designer
|
| 289 |
+
Stefan Kristiansson
|
| 290 |
+
Stefan O'Rear
|
| 291 |
+
Szabolcs Nagy
|
| 292 |
+
Timo Teräs
|
| 293 |
+
Trutz Behn
|
| 294 |
+
Valentin Ochs
|
| 295 |
+
Will Dietz
|
| 296 |
+
William Haddon
|
| 297 |
+
William Pitcock
|
| 298 |
+
|
| 299 |
+
Portions of this software are derived from third-party works licensed
|
| 300 |
+
under terms compatible with the above MIT license:
|
| 301 |
+
|
| 302 |
+
The TRE regular expression implementation (src/regex/reg* and
|
| 303 |
+
src/regex/tre*) is Copyright © 2001-2008 Ville Laurikari and licensed
|
| 304 |
+
under a 2-clause BSD license (license text in the source files). The
|
| 305 |
+
included version has been heavily modified by Rich Felker in 2012, in
|
| 306 |
+
the interests of size, simplicity, and namespace cleanliness.
|
| 307 |
+
|
| 308 |
+
Much of the math library code (src/math/* and src/complex/*) is
|
| 309 |
+
Copyright © 1993,2004 Sun Microsystems or
|
| 310 |
+
Copyright © 2003-2011 David Schultz or
|
| 311 |
+
Copyright © 2003-2009 Steven G. Kargl or
|
| 312 |
+
Copyright © 2003-2009 Bruce D. Evans or
|
| 313 |
+
Copyright © 2008 Stephen L. Moshier or
|
| 314 |
+
Copyright © 2017-2018 Arm Limited
|
| 315 |
+
and labelled as such in comments in the individual source files. All
|
| 316 |
+
have been licensed under extremely permissive terms.
|
| 317 |
+
|
| 318 |
+
The ARM memcpy code (src/string/arm/memcpy.S) is Copyright © 2008
|
| 319 |
+
The Android Open Source Project and is licensed under a two-clause BSD
|
| 320 |
+
license. It was taken from Bionic libc, used on Android.
|
| 321 |
+
|
| 322 |
+
The AArch64 memcpy and memset code (src/string/aarch64/*) are
|
| 323 |
+
Copyright © 1999-2019, Arm Limited.
|
| 324 |
+
|
| 325 |
+
The implementation of DES for crypt (src/crypt/crypt_des.c) is
|
| 326 |
+
Copyright © 1994 David Burren. It is licensed under a BSD license.
|
| 327 |
+
|
| 328 |
+
The implementation of blowfish crypt (src/crypt/crypt_blowfish.c) was
|
| 329 |
+
originally written by Solar Designer and placed into the public
|
| 330 |
+
domain. The code also comes with a fallback permissive license for use
|
| 331 |
+
in jurisdictions that may not recognize the public domain.
|
| 332 |
+
|
| 333 |
+
The smoothsort implementation (src/stdlib/qsort.c) is Copyright © 2011
|
| 334 |
+
Valentin Ochs and is licensed under an MIT-style license.
|
| 335 |
+
|
| 336 |
+
The x86_64 port was written by Nicholas J. Kain and is licensed under
|
| 337 |
+
the standard MIT terms.
|
| 338 |
+
|
| 339 |
+
The mips and microblaze ports were originally written by Richard
|
| 340 |
+
Pennington for use in the ellcc project. The original code was adapted
|
| 341 |
+
by Rich Felker for build system and code conventions during upstream
|
| 342 |
+
integration. It is licensed under the standard MIT terms.
|
| 343 |
+
|
| 344 |
+
The mips64 port was contributed by Imagination Technologies and is
|
| 345 |
+
licensed under the standard MIT terms.
|
| 346 |
+
|
| 347 |
+
The powerpc port was also originally written by Richard Pennington,
|
| 348 |
+
and later supplemented and integrated by John Spencer. It is licensed
|
| 349 |
+
under the standard MIT terms.
|
| 350 |
+
|
| 351 |
+
All other files which have no copyright comments are original works
|
| 352 |
+
produced specifically for use as part of this library, written either
|
| 353 |
+
by Rich Felker, the main author of the library, or by one or more
|
| 354 |
+
contibutors listed above. Details on authorship of individual files
|
| 355 |
+
can be found in the git version control history of the project. The
|
| 356 |
+
omission of copyright and license comments in each file is in the
|
| 357 |
+
interest of source tree size.
|
| 358 |
+
|
| 359 |
+
In addition, permission is hereby granted for all public header files
|
| 360 |
+
(include/* and arch/*/bits/*) and crt files intended to be linked into
|
| 361 |
+
applications (crt/*, ldso/dlstart.c, and arch/*/crt_arch.h) to omit
|
| 362 |
+
the copyright notice and permission notice otherwise required by the
|
| 363 |
+
license, and to use these files without any requirement of
|
| 364 |
+
attribution. These files include substantial contributions from:
|
| 365 |
+
|
| 366 |
+
Bobby Bingham
|
| 367 |
+
John Spencer
|
| 368 |
+
Nicholas J. Kain
|
| 369 |
+
Rich Felker
|
| 370 |
+
Richard Pennington
|
| 371 |
+
Stefan Kristiansson
|
| 372 |
+
Szabolcs Nagy
|
| 373 |
+
|
| 374 |
+
all of whom have explicitly granted such permission.
|
| 375 |
+
|
| 376 |
+
This file previously contained text expressing a belief that most of
|
| 377 |
+
the files covered by the above exception were sufficiently trivial not
|
| 378 |
+
to be subject to copyright, resulting in confusion over whether it
|
| 379 |
+
negated the permissions granted in the license. In the spirit of
|
| 380 |
+
permissive licensing, and of not having licensing issues being an
|
| 381 |
+
obstacle to adoption, that text has been removed.Copyright (c) 2005-2023, NumPy Developers.
|
| 382 |
+
All rights reserved.
|
| 383 |
+
|
| 384 |
+
Redistribution and use in source and binary forms, with or without
|
| 385 |
+
modification, are permitted provided that the following conditions are
|
| 386 |
+
met:
|
| 387 |
+
|
| 388 |
+
* Redistributions of source code must retain the above copyright
|
| 389 |
+
notice, this list of conditions and the following disclaimer.
|
| 390 |
+
|
| 391 |
+
* Redistributions in binary form must reproduce the above
|
| 392 |
+
copyright notice, this list of conditions and the following
|
| 393 |
+
disclaimer in the documentation and/or other materials provided
|
| 394 |
+
with the distribution.
|
| 395 |
+
|
| 396 |
+
* Neither the name of the NumPy Developers nor the names of any
|
| 397 |
+
contributors may be used to endorse or promote products derived
|
| 398 |
+
from this software without specific prior written permission.
|
| 399 |
+
|
| 400 |
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
| 401 |
+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
| 402 |
+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
| 403 |
+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
| 404 |
+
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
| 405 |
+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
| 406 |
+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
| 407 |
+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
| 408 |
+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
| 409 |
+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
| 410 |
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
| 411 |
+
Apache License
|
| 412 |
+
Version 2.0, January 2004
|
| 413 |
+
http://www.apache.org/licenses/
|
| 414 |
+
|
| 415 |
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
| 416 |
+
|
| 417 |
+
1. Definitions.
|
| 418 |
+
|
| 419 |
+
"License" shall mean the terms and conditions for use, reproduction,
|
| 420 |
+
and distribution as defined by Sections 1 through 9 of this document.
|
| 421 |
+
|
| 422 |
+
"Licensor" shall mean the copyright owner or entity authorized by
|
| 423 |
+
the copyright owner that is granting the License.
|
| 424 |
+
|
| 425 |
+
"Legal Entity" shall mean the union of the acting entity and all
|
| 426 |
+
other entities that control, are controlled by, or are under common
|
| 427 |
+
control with that entity. For the purposes of this definition,
|
| 428 |
+
"control" means (i) the power, direct or indirect, to cause the
|
| 429 |
+
direction or management of such entity, whether by contract or
|
| 430 |
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
| 431 |
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
| 432 |
+
|
| 433 |
+
"You" (or "Your") shall mean an individual or Legal Entity
|
| 434 |
+
exercising permissions granted by this License.
|
| 435 |
+
|
| 436 |
+
"Source" form shall mean the preferred form for making modifications,
|
| 437 |
+
including but not limited to software source code, documentation
|
| 438 |
+
source, and configuration files.
|
| 439 |
+
|
| 440 |
+
"Object" form shall mean any form resulting from mechanical
|
| 441 |
+
transformation or translation of a Source form, including but
|
| 442 |
+
not limited to compiled object code, generated documentation,
|
| 443 |
+
and conversions to other media types.
|
| 444 |
+
|
| 445 |
+
"Work" shall mean the work of authorship, whether in Source or
|
| 446 |
+
Object form, made available under the License, as indicated by a
|
| 447 |
+
copyright notice that is included in or attached to the work
|
| 448 |
+
(an example is provided in the Appendix below).
|
| 449 |
+
|
| 450 |
+
"Derivative Works" shall mean any work, whether in Source or Object
|
| 451 |
+
form, that is based on (or derived from) the Work and for which the
|
| 452 |
+
editorial revisions, annotations, elaborations, or other modifications
|
| 453 |
+
represent, as a whole, an original work of authorship. For the purposes
|
| 454 |
+
of this License, Derivative Works shall not include works that remain
|
| 455 |
+
separable from, or merely link (or bind by name) to the interfaces of,
|
| 456 |
+
the Work and Derivative Works thereof.
|
| 457 |
+
|
| 458 |
+
"Contribution" shall mean any work of authorship, including
|
| 459 |
+
the original version of the Work and any modifications or additions
|
| 460 |
+
to that Work or Derivative Works thereof, that is intentionally
|
| 461 |
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
| 462 |
+
or by an individual or Legal Entity authorized to submit on behalf of
|
| 463 |
+
the copyright owner. For the purposes of this definition, "submitted"
|
| 464 |
+
means any form of electronic, verbal, or written communication sent
|
| 465 |
+
to the Licensor or its representatives, including but not limited to
|
| 466 |
+
communication on electronic mailing lists, source code control systems,
|
| 467 |
+
and issue tracking systems that are managed by, or on behalf of, the
|
| 468 |
+
Licensor for the purpose of discussing and improving the Work, but
|
| 469 |
+
excluding communication that is conspicuously marked or otherwise
|
| 470 |
+
designated in writing by the copyright owner as "Not a Contribution."
|
| 471 |
+
|
| 472 |
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
| 473 |
+
on behalf of whom a Contribution has been received by Licensor and
|
| 474 |
+
subsequently incorporated within the Work.
|
| 475 |
+
|
| 476 |
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
| 477 |
+
this License, each Contributor hereby grants to You a perpetual,
|
| 478 |
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
| 479 |
+
copyright license to reproduce, prepare Derivative Works of,
|
| 480 |
+
publicly display, publicly perform, sublicense, and distribute the
|
| 481 |
+
Work and such Derivative Works in Source or Object form.
|
| 482 |
+
|
| 483 |
+
3. Grant of Patent License. Subject to the terms and conditions of
|
| 484 |
+
this License, each Contributor hereby grants to You a perpetual,
|
| 485 |
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
| 486 |
+
(except as stated in this section) patent license to make, have made,
|
| 487 |
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
| 488 |
+
where such license applies only to those patent claims licensable
|
| 489 |
+
by such Contributor that are necessarily infringed by their
|
| 490 |
+
Contribution(s) alone or by combination of their Contribution(s)
|
| 491 |
+
with the Work to which such Contribution(s) was submitted. If You
|
| 492 |
+
institute patent litigation against any entity (including a
|
| 493 |
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
| 494 |
+
or a Contribution incorporated within the Work constitutes direct
|
| 495 |
+
or contributory patent infringement, then any patent licenses
|
| 496 |
+
granted to You under this License for that Work shall terminate
|
| 497 |
+
as of the date such litigation is filed.
|
| 498 |
+
|
| 499 |
+
4. Redistribution. You may reproduce and distribute copies of the
|
| 500 |
+
Work or Derivative Works thereof in any medium, with or without
|
| 501 |
+
modifications, and in Source or Object form, provided that You
|
| 502 |
+
meet the following conditions:
|
| 503 |
+
|
| 504 |
+
(a) You must give any other recipients of the Work or
|
| 505 |
+
Derivative Works a copy of this License; and
|
| 506 |
+
|
| 507 |
+
(b) You must cause any modified files to carry prominent notices
|
| 508 |
+
stating that You changed the files; and
|
| 509 |
+
|
| 510 |
+
(c) You must retain, in the Source form of any Derivative Works
|
| 511 |
+
that You distribute, all copyright, patent, trademark, and
|
| 512 |
+
attribution notices from the Source form of the Work,
|
| 513 |
+
excluding those notices that do not pertain to any part of
|
| 514 |
+
the Derivative Works; and
|
| 515 |
+
|
| 516 |
+
(d) If the Work includes a "NOTICE" text file as part of its
|
| 517 |
+
distribution, then any Derivative Works that You distribute must
|
| 518 |
+
include a readable copy of the attribution notices contained
|
| 519 |
+
within such NOTICE file, excluding those notices that do not
|
| 520 |
+
pertain to any part of the Derivative Works, in at least one
|
| 521 |
+
of the following places: within a NOTICE text file distributed
|
| 522 |
+
as part of the Derivative Works; within the Source form or
|
| 523 |
+
documentation, if provided along with the Derivative Works; or,
|
| 524 |
+
within a display generated by the Derivative Works, if and
|
| 525 |
+
wherever such third-party notices normally appear. The contents
|
| 526 |
+
of the NOTICE file are for informational purposes only and
|
| 527 |
+
do not modify the License. You may add Your own attribution
|
| 528 |
+
notices within Derivative Works that You distribute, alongside
|
| 529 |
+
or as an addendum to the NOTICE text from the Work, provided
|
| 530 |
+
that such additional attribution notices cannot be construed
|
| 531 |
+
as modifying the License.
|
| 532 |
+
|
| 533 |
+
You may add Your own copyright statement to Your modifications and
|
| 534 |
+
may provide additional or different license terms and conditions
|
| 535 |
+
for use, reproduction, or distribution of Your modifications, or
|
| 536 |
+
for any such Derivative Works as a whole, provided Your use,
|
| 537 |
+
reproduction, and distribution of the Work otherwise complies with
|
| 538 |
+
the conditions stated in this License.
|
| 539 |
+
|
| 540 |
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
| 541 |
+
any Contribution intentionally submitted for inclusion in the Work
|
| 542 |
+
by You to the Licensor shall be under the terms and conditions of
|
| 543 |
+
this License, without any additional terms or conditions.
|
| 544 |
+
Notwithstanding the above, nothing herein shall supersede or modify
|
| 545 |
+
the terms of any separate license agreement you may have executed
|
| 546 |
+
with Licensor regarding such Contributions.
|
| 547 |
+
|
| 548 |
+
6. Trademarks. This License does not grant permission to use the trade
|
| 549 |
+
names, trademarks, service marks, or product names of the Licensor,
|
| 550 |
+
except as required for reasonable and customary use in describing the
|
| 551 |
+
origin of the Work and reproducing the content of the NOTICE file.
|
| 552 |
+
|
| 553 |
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
| 554 |
+
agreed to in writing, Licensor provides the Work (and each
|
| 555 |
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
| 556 |
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
| 557 |
+
implied, including, without limitation, any warranties or conditions
|
| 558 |
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
| 559 |
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
| 560 |
+
appropriateness of using or redistributing the Work and assume any
|
| 561 |
+
risks associated with Your exercise of permissions under this License.
|
| 562 |
+
|
| 563 |
+
8. Limitation of Liability. In no event and under no legal theory,
|
| 564 |
+
whether in tort (including negligence), contract, or otherwise,
|
| 565 |
+
unless required by applicable law (such as deliberate and grossly
|
| 566 |
+
negligent acts) or agreed to in writing, shall any Contributor be
|
| 567 |
+
liable to You for damages, including any direct, indirect, special,
|
| 568 |
+
incidental, or consequential damages of any character arising as a
|
| 569 |
+
result of this License or out of the use or inability to use the
|
| 570 |
+
Work (including but not limited to damages for loss of goodwill,
|
| 571 |
+
work stoppage, computer failure or malfunction, or any and all
|
| 572 |
+
other commercial damages or losses), even if such Contributor
|
| 573 |
+
has been advised of the possibility of such damages.
|
| 574 |
+
|
| 575 |
+
9. Accepting Warranty or Additional Liability. While redistributing
|
| 576 |
+
the Work or Derivative Works thereof, You may choose to offer,
|
| 577 |
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
| 578 |
+
or other liability obligations and/or rights consistent with this
|
| 579 |
+
License. However, in accepting such obligations, You may act only
|
| 580 |
+
on Your own behalf and on Your sole responsibility, not on behalf
|
| 581 |
+
of any other Contributor, and only if You agree to indemnify,
|
| 582 |
+
defend, and hold each Contributor harmless for any liability
|
| 583 |
+
incurred by, or claims asserted against, such Contributor by reason
|
| 584 |
+
of your accepting any such warranty or additional liability.
|
| 585 |
+
|
| 586 |
+
END OF TERMS AND CONDITIONS
|
| 587 |
+
|
| 588 |
+
|
| 589 |
+
Copyright (c) Donald Stufft and individual contributors.
|
| 590 |
+
All rights reserved.
|
| 591 |
+
|
| 592 |
+
Redistribution and use in source and binary forms, with or without
|
| 593 |
+
modification, are permitted provided that the following conditions are met:
|
| 594 |
+
|
| 595 |
+
1. Redistributions of source code must retain the above copyright notice,
|
| 596 |
+
this list of conditions and the following disclaimer.
|
| 597 |
+
|
| 598 |
+
2. Redistributions in binary form must reproduce the above copyright
|
| 599 |
+
notice, this list of conditions and the following disclaimer in the
|
| 600 |
+
documentation and/or other materials provided with the distribution.
|
| 601 |
+
|
| 602 |
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
| 603 |
+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
| 604 |
+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
| 605 |
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
| 606 |
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
| 607 |
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
| 608 |
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
| 609 |
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
| 610 |
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
| 611 |
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.A. HISTORY OF THE SOFTWARE
|
| 612 |
+
==========================
|
| 613 |
+
|
| 614 |
+
Python was created in the early 1990s by Guido van Rossum at Stichting
|
| 615 |
+
Mathematisch Centrum (CWI, see https://www.cwi.nl) in the Netherlands
|
| 616 |
+
as a successor of a language called ABC. Guido remains Python's
|
| 617 |
+
principal author, although it includes many contributions from others.
|
| 618 |
+
|
| 619 |
+
In 1995, Guido continued his work on Python at the Corporation for
|
| 620 |
+
National Research Initiatives (CNRI, see https://www.cnri.reston.va.us)
|
| 621 |
+
in Reston, Virginia where he released several versions of the
|
| 622 |
+
software.
|
| 623 |
+
|
| 624 |
+
In May 2000, Guido and the Python core development team moved to
|
| 625 |
+
BeOpen.com to form the BeOpen PythonLabs team. In October of the same
|
| 626 |
+
year, the PythonLabs team moved to Digital Creations, which became
|
| 627 |
+
Zope Corporation. In 2001, the Python Software Foundation (PSF, see
|
| 628 |
+
https://www.python.org/psf/) was formed, a non-profit organization
|
| 629 |
+
created specifically to own Python-related Intellectual Property.
|
| 630 |
+
Zope Corporation was a sponsoring member of the PSF.
|
| 631 |
+
|
| 632 |
+
All Python releases are Open Source (see https://opensource.org for
|
| 633 |
+
the Open Source Definition). Historically, most, but not all, Python
|
| 634 |
+
releases have also been GPL-compatible; the table below summarizes
|
| 635 |
+
the various releases.
|
| 636 |
+
|
| 637 |
+
Release Derived Year Owner GPL-
|
| 638 |
+
from compatible? (1)
|
| 639 |
+
|
| 640 |
+
0.9.0 thru 1.2 1991-1995 CWI yes
|
| 641 |
+
1.3 thru 1.5.2 1.2 1995-1999 CNRI yes
|
| 642 |
+
1.6 1.5.2 2000 CNRI no
|
| 643 |
+
2.0 1.6 2000 BeOpen.com no
|
| 644 |
+
1.6.1 1.6 2001 CNRI yes (2)
|
| 645 |
+
2.1 2.0+1.6.1 2001 PSF no
|
| 646 |
+
2.0.1 2.0+1.6.1 2001 PSF yes
|
| 647 |
+
2.1.1 2.1+2.0.1 2001 PSF yes
|
| 648 |
+
2.1.2 2.1.1 2002 PSF yes
|
| 649 |
+
2.1.3 2.1.2 2002 PSF yes
|
| 650 |
+
2.2 and above 2.1.1 2001-now PSF yes
|
| 651 |
+
|
| 652 |
+
Footnotes:
|
| 653 |
+
|
| 654 |
+
(1) GPL-compatible doesn't mean that we're distributing Python under
|
| 655 |
+
the GPL. All Python licenses, unlike the GPL, let you distribute
|
| 656 |
+
a modified version without making your changes open source. The
|
| 657 |
+
GPL-compatible licenses make it possible to combine Python with
|
| 658 |
+
other software that is released under the GPL; the others don't.
|
| 659 |
+
|
| 660 |
+
(2) According to Richard Stallman, 1.6.1 is not GPL-compatible,
|
| 661 |
+
because its license has a choice of law clause. According to
|
| 662 |
+
CNRI, however, Stallman's lawyer has told CNRI's lawyer that 1.6.1
|
| 663 |
+
is "not incompatible" with the GPL.
|
| 664 |
+
|
| 665 |
+
Thanks to the many outside volunteers who have worked under Guido's
|
| 666 |
+
direction to make these releases possible.
|
| 667 |
+
|
| 668 |
+
|
| 669 |
+
B. TERMS AND CONDITIONS FOR ACCESSING OR OTHERWISE USING PYTHON
|
| 670 |
+
===============================================================
|
| 671 |
+
|
| 672 |
+
Python software and documentation are licensed under the
|
| 673 |
+
Python Software Foundation License Version 2.
|
| 674 |
+
|
| 675 |
+
Starting with Python 3.8.6, examples, recipes, and other code in
|
| 676 |
+
the documentation are dual licensed under the PSF License Version 2
|
| 677 |
+
and the Zero-Clause BSD license.
|
| 678 |
+
|
| 679 |
+
Some software incorporated into Python is under different licenses.
|
| 680 |
+
The licenses are listed with code falling under that license.
|
| 681 |
+
|
| 682 |
+
|
| 683 |
+
PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
|
| 684 |
+
--------------------------------------------
|
| 685 |
+
|
| 686 |
+
1. This LICENSE AGREEMENT is between the Python Software Foundation
|
| 687 |
+
("PSF"), and the Individual or Organization ("Licensee") accessing and
|
| 688 |
+
otherwise using this software ("Python") in source or binary form and
|
| 689 |
+
its associated documentation.
|
| 690 |
+
|
| 691 |
+
2. Subject to the terms and conditions of this License Agreement, PSF hereby
|
| 692 |
+
grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
|
| 693 |
+
analyze, test, perform and/or display publicly, prepare derivative works,
|
| 694 |
+
distribute, and otherwise use Python alone or in any derivative version,
|
| 695 |
+
provided, however, that PSF's License Agreement and PSF's notice of copyright,
|
| 696 |
+
i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
|
| 697 |
+
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Python Software Foundation;
|
| 698 |
+
All Rights Reserved" are retained in Python alone or in any derivative version
|
| 699 |
+
prepared by Licensee.
|
| 700 |
+
|
| 701 |
+
3. In the event Licensee prepares a derivative work that is based on
|
| 702 |
+
or incorporates Python or any part thereof, and wants to make
|
| 703 |
+
the derivative work available to others as provided herein, then
|
| 704 |
+
Licensee hereby agrees to include in any such work a brief summary of
|
| 705 |
+
the changes made to Python.
|
| 706 |
+
|
| 707 |
+
4. PSF is making Python available to Licensee on an "AS IS"
|
| 708 |
+
basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
|
| 709 |
+
IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
|
| 710 |
+
DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
|
| 711 |
+
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
|
| 712 |
+
INFRINGE ANY THIRD PARTY RIGHTS.
|
| 713 |
+
|
| 714 |
+
5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
|
| 715 |
+
FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
|
| 716 |
+
A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
|
| 717 |
+
OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
|
| 718 |
+
|
| 719 |
+
6. This License Agreement will automatically terminate upon a material
|
| 720 |
+
breach of its terms and conditions.
|
| 721 |
+
|
| 722 |
+
7. Nothing in this License Agreement shall be deemed to create any
|
| 723 |
+
relationship of agency, partnership, or joint venture between PSF and
|
| 724 |
+
Licensee. This License Agreement does not grant permission to use PSF
|
| 725 |
+
trademarks or trade name in a trademark sense to endorse or promote
|
| 726 |
+
products or services of Licensee, or any third party.
|
| 727 |
+
|
| 728 |
+
8. By copying, installing or otherwise using Python, Licensee
|
| 729 |
+
agrees to be bound by the terms and conditions of this License
|
| 730 |
+
Agreement.
|
| 731 |
+
|
| 732 |
+
|
| 733 |
+
BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0
|
| 734 |
+
-------------------------------------------
|
| 735 |
+
|
| 736 |
+
BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1
|
| 737 |
+
|
| 738 |
+
1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an
|
| 739 |
+
office at 160 Saratoga Avenue, Santa Clara, CA 95051, and the
|
| 740 |
+
Individual or Organization ("Licensee") accessing and otherwise using
|
| 741 |
+
this software in source or binary form and its associated
|
| 742 |
+
documentation ("the Software").
|
| 743 |
+
|
| 744 |
+
2. Subject to the terms and conditions of this BeOpen Python License
|
| 745 |
+
Agreement, BeOpen hereby grants Licensee a non-exclusive,
|
| 746 |
+
royalty-free, world-wide license to reproduce, analyze, test, perform
|
| 747 |
+
and/or display publicly, prepare derivative works, distribute, and
|
| 748 |
+
otherwise use the Software alone or in any derivative version,
|
| 749 |
+
provided, however, that the BeOpen Python License is retained in the
|
| 750 |
+
Software, alone or in any derivative version prepared by Licensee.
|
| 751 |
+
|
| 752 |
+
3. BeOpen is making the Software available to Licensee on an "AS IS"
|
| 753 |
+
basis. BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
|
| 754 |
+
IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND
|
| 755 |
+
DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
|
| 756 |
+
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE WILL NOT
|
| 757 |
+
INFRINGE ANY THIRD PARTY RIGHTS.
|
| 758 |
+
|
| 759 |
+
4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE
|
| 760 |
+
SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS
|
| 761 |
+
AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY
|
| 762 |
+
DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
|
| 763 |
+
|
| 764 |
+
5. This License Agreement will automatically terminate upon a material
|
| 765 |
+
breach of its terms and conditions.
|
| 766 |
+
|
| 767 |
+
6. This License Agreement shall be governed by and interpreted in all
|
| 768 |
+
respects by the law of the State of California, excluding conflict of
|
| 769 |
+
law provisions. Nothing in this License Agreement shall be deemed to
|
| 770 |
+
create any relationship of agency, partnership, or joint venture
|
| 771 |
+
between BeOpen and Licensee. This License Agreement does not grant
|
| 772 |
+
permission to use BeOpen trademarks or trade names in a trademark
|
| 773 |
+
sense to endorse or promote products or services of Licensee, or any
|
| 774 |
+
third party. As an exception, the "BeOpen Python" logos available at
|
| 775 |
+
http://www.pythonlabs.com/logos.html may be used according to the
|
| 776 |
+
permissions granted on that web page.
|
| 777 |
+
|
| 778 |
+
7. By copying, installing or otherwise using the software, Licensee
|
| 779 |
+
agrees to be bound by the terms and conditions of this License
|
| 780 |
+
Agreement.
|
| 781 |
+
|
| 782 |
+
|
| 783 |
+
CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1
|
| 784 |
+
---------------------------------------
|
| 785 |
+
|
| 786 |
+
1. This LICENSE AGREEMENT is between the Corporation for National
|
| 787 |
+
Research Initiatives, having an office at 1895 Preston White Drive,
|
| 788 |
+
Reston, VA 20191 ("CNRI"), and the Individual or Organization
|
| 789 |
+
("Licensee") accessing and otherwise using Python 1.6.1 software in
|
| 790 |
+
source or binary form and its associated documentation.
|
| 791 |
+
|
| 792 |
+
2. Subject to the terms and conditions of this License Agreement, CNRI
|
| 793 |
+
hereby grants Licensee a nonexclusive, royalty-free, world-wide
|
| 794 |
+
license to reproduce, analyze, test, perform and/or display publicly,
|
| 795 |
+
prepare derivative works, distribute, and otherwise use Python 1.6.1
|
| 796 |
+
alone or in any derivative version, provided, however, that CNRI's
|
| 797 |
+
License Agreement and CNRI's notice of copyright, i.e., "Copyright (c)
|
| 798 |
+
1995-2001 Corporation for National Research Initiatives; All Rights
|
| 799 |
+
Reserved" are retained in Python 1.6.1 alone or in any derivative
|
| 800 |
+
version prepared by Licensee. Alternately, in lieu of CNRI's License
|
| 801 |
+
Agreement, Licensee may substitute the following text (omitting the
|
| 802 |
+
quotes): "Python 1.6.1 is made available subject to the terms and
|
| 803 |
+
conditions in CNRI's License Agreement. This Agreement together with
|
| 804 |
+
Python 1.6.1 may be located on the internet using the following
|
| 805 |
+
unique, persistent identifier (known as a handle): 1895.22/1013. This
|
| 806 |
+
Agreement may also be obtained from a proxy server on the internet
|
| 807 |
+
using the following URL: http://hdl.handle.net/1895.22/1013".
|
| 808 |
+
|
| 809 |
+
3. In the event Licensee prepares a derivative work that is based on
|
| 810 |
+
or incorporates Python 1.6.1 or any part thereof, and wants to make
|
| 811 |
+
the derivative work available to others as provided herein, then
|
| 812 |
+
Licensee hereby agrees to include in any such work a brief summary of
|
| 813 |
+
the changes made to Python 1.6.1.
|
| 814 |
+
|
| 815 |
+
4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS"
|
| 816 |
+
basis. CNRI MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
|
| 817 |
+
IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, CNRI MAKES NO AND
|
| 818 |
+
DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
|
| 819 |
+
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON 1.6.1 WILL NOT
|
| 820 |
+
INFRINGE ANY THIRD PARTY RIGHTS.
|
| 821 |
+
|
| 822 |
+
5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
|
| 823 |
+
1.6.1 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
|
| 824 |
+
A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1,
|
| 825 |
+
OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
|
| 826 |
+
|
| 827 |
+
6. This License Agreement will automatically terminate upon a material
|
| 828 |
+
breach of its terms and conditions.
|
| 829 |
+
|
| 830 |
+
7. This License Agreement shall be governed by the federal
|
| 831 |
+
intellectual property law of the United States, including without
|
| 832 |
+
limitation the federal copyright law, and, to the extent such
|
| 833 |
+
U.S. federal law does not apply, by the law of the Commonwealth of
|
| 834 |
+
Virginia, excluding Virginia's conflict of law provisions.
|
| 835 |
+
Notwithstanding the foregoing, with regard to derivative works based
|
| 836 |
+
on Python 1.6.1 that incorporate non-separable material that was
|
| 837 |
+
previously distributed under the GNU General Public License (GPL), the
|
| 838 |
+
law of the Commonwealth of Virginia shall govern this License
|
| 839 |
+
Agreement only as to issues arising under or with respect to
|
| 840 |
+
Paragraphs 4, 5, and 7 of this License Agreement. Nothing in this
|
| 841 |
+
License Agreement shall be deemed to create any relationship of
|
| 842 |
+
agency, partnership, or joint venture between CNRI and Licensee. This
|
| 843 |
+
License Agreement does not grant permission to use CNRI trademarks or
|
| 844 |
+
trade name in a trademark sense to endorse or promote products or
|
| 845 |
+
services of Licensee, or any third party.
|
| 846 |
+
|
| 847 |
+
8. By clicking on the "ACCEPT" button where indicated, or by copying,
|
| 848 |
+
installing or otherwise using Python 1.6.1, Licensee agrees to be
|
| 849 |
+
bound by the terms and conditions of this License Agreement.
|
| 850 |
+
|
| 851 |
+
ACCEPT
|
| 852 |
+
|
| 853 |
+
|
| 854 |
+
CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2
|
| 855 |
+
--------------------------------------------------
|
| 856 |
+
|
| 857 |
+
Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum Amsterdam,
|
| 858 |
+
The Netherlands. All rights reserved.
|
| 859 |
+
|
| 860 |
+
Permission to use, copy, modify, and distribute this software and its
|
| 861 |
+
documentation for any purpose and without fee is hereby granted,
|
| 862 |
+
provided that the above copyright notice appear in all copies and that
|
| 863 |
+
both that copyright notice and this permission notice appear in
|
| 864 |
+
supporting documentation, and that the name of Stichting Mathematisch
|
| 865 |
+
Centrum or CWI not be used in advertising or publicity pertaining to
|
| 866 |
+
distribution of the software without specific, written prior
|
| 867 |
+
permission.
|
| 868 |
+
|
| 869 |
+
STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
|
| 870 |
+
THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
| 871 |
+
FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
|
| 872 |
+
FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
| 873 |
+
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
| 874 |
+
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
|
| 875 |
+
OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
| 876 |
+
|
| 877 |
+
ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION
|
| 878 |
+
----------------------------------------------------------------------
|
| 879 |
+
|
| 880 |
+
Permission to use, copy, modify, and/or distribute this software for any
|
| 881 |
+
purpose with or without fee is hereby granted.
|
| 882 |
+
|
| 883 |
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
| 884 |
+
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
| 885 |
+
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
| 886 |
+
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
| 887 |
+
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
| 888 |
+
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
| 889 |
+
PERFORMANCE OF THIS SOFTWARE.
|
| 890 |
+
Copyright (c) 2014, Al Sweigart
|
| 891 |
+
All rights reserved.
|
| 892 |
+
|
| 893 |
+
Redistribution and use in source and binary forms, with or without
|
| 894 |
+
modification, are permitted provided that the following conditions are met:
|
| 895 |
+
|
| 896 |
+
* Redistributions of source code must retain the above copyright notice, this
|
| 897 |
+
list of conditions and the following disclaimer.
|
| 898 |
+
|
| 899 |
+
* Redistributions in binary form must reproduce the above copyright notice,
|
| 900 |
+
this list of conditions and the following disclaimer in the documentation
|
| 901 |
+
and/or other materials provided with the distribution.
|
| 902 |
+
|
| 903 |
+
* Neither the name of the {organization} nor the names of its
|
| 904 |
+
contributors may be used to endorse or promote products derived from
|
| 905 |
+
this software without specific prior written permission.
|
| 906 |
+
|
| 907 |
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
| 908 |
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
| 909 |
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
| 910 |
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
| 911 |
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
| 912 |
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
| 913 |
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
| 914 |
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
| 915 |
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
| 916 |
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.Copyright (c) 2017 Anthony Sottile
|
| 917 |
+
|
| 918 |
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
| 919 |
+
of this software and associated documentation files (the "Software"), to deal
|
| 920 |
+
in the Software without restriction, including without limitation the rights
|
| 921 |
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
| 922 |
+
copies of the Software, and to permit persons to whom the Software is
|
| 923 |
+
furnished to do so, subject to the following conditions:
|
| 924 |
+
|
| 925 |
+
The above copyright notice and this permission notice shall be included in
|
| 926 |
+
all copies or substantial portions of the Software.
|
| 927 |
+
|
| 928 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 929 |
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| 930 |
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| 931 |
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| 932 |
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
| 933 |
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
| 934 |
+
THE SOFTWARE.Copyright (c) 2015-2019 Jared Hobbs
|
| 935 |
+
|
| 936 |
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
| 937 |
+
this software and associated documentation files (the "Software"), to deal in
|
| 938 |
+
the Software without restriction, including without limitation the rights to
|
| 939 |
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
| 940 |
+
of the Software, and to permit persons to whom the Software is furnished to do
|
| 941 |
+
so, subject to the following conditions:
|
| 942 |
+
|
| 943 |
+
The above copyright notice and this permission notice shall be included in all
|
| 944 |
+
copies or substantial portions of the Software.
|
| 945 |
+
|
| 946 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 947 |
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| 948 |
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| 949 |
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| 950 |
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
| 951 |
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
| 952 |
+
SOFTWARE.Developed by ESN, an Electronic Arts Inc. studio.
|
| 953 |
+
Copyright (c) 2014, Electronic Arts Inc.
|
| 954 |
+
All rights reserved.
|
| 955 |
+
|
| 956 |
+
Redistribution and use in source and binary forms, with or without
|
| 957 |
+
modification, are permitted provided that the following conditions are met:
|
| 958 |
+
* Redistributions of source code must retain the above copyright
|
| 959 |
+
notice, this list of conditions and the following disclaimer.
|
| 960 |
+
* Redistributions in binary form must reproduce the above copyright
|
| 961 |
+
notice, this list of conditions and the following disclaimer in the
|
| 962 |
+
documentation and/or other materials provided with the distribution.
|
| 963 |
+
* Neither the name of ESN, Electronic Arts Inc. nor the
|
| 964 |
+
names of its contributors may be used to endorse or promote products
|
| 965 |
+
derived from this software without specific prior written permission.
|
| 966 |
+
|
| 967 |
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
| 968 |
+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
| 969 |
+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
| 970 |
+
DISCLAIMED. IN NO EVENT SHALL ELECTRONIC ARTS INC. BE LIABLE
|
| 971 |
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
| 972 |
+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
| 973 |
+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
| 974 |
+
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
| 975 |
+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
| 976 |
+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
| 977 |
+
|
| 978 |
+
----
|
| 979 |
+
|
| 980 |
+
Portions of code from MODP_ASCII - Ascii transformations (upper/lower, etc)
|
| 981 |
+
https://github.com/client9/stringencoders
|
| 982 |
+
|
| 983 |
+
Copyright 2005, 2006, 2007
|
| 984 |
+
Nick Galbreath -- nickg [at] modp [dot] com
|
| 985 |
+
All rights reserved.
|
| 986 |
+
|
| 987 |
+
Redistribution and use in source and binary forms, with or without
|
| 988 |
+
modification, are permitted provided that the following conditions are
|
| 989 |
+
met:
|
| 990 |
+
|
| 991 |
+
Redistributions of source code must retain the above copyright
|
| 992 |
+
notice, this list of conditions and the following disclaimer.
|
| 993 |
+
|
| 994 |
+
Redistributions in binary form must reproduce the above copyright
|
| 995 |
+
notice, this list of conditions and the following disclaimer in the
|
| 996 |
+
documentation and/or other materials provided with the distribution.
|
| 997 |
+
|
| 998 |
+
Neither the name of the modp.com nor the names of its
|
| 999 |
+
contributors may be used to endorse or promote products derived from
|
| 1000 |
+
this software without specific prior written permission.
|
| 1001 |
+
|
| 1002 |
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
| 1003 |
+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
| 1004 |
+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
| 1005 |
+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
| 1006 |
+
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
| 1007 |
+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
| 1008 |
+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
| 1009 |
+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
| 1010 |
+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
| 1011 |
+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
| 1012 |
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
| 1013 |
+
|
| 1014 |
+
This is the standard "new" BSD license:
|
| 1015 |
+
http://www.opensource.org/licenses/bsd-license.php
|
| 1016 |
+
|
| 1017 |
+
https://github.com/client9/stringencoders/blob/cfd5c1507325ae497ea9bacdacba12c0ffd79d30/COPYING
|
| 1018 |
+
|
| 1019 |
+
----
|
| 1020 |
+
|
| 1021 |
+
Numeric decoder derived from from TCL library
|
| 1022 |
+
https://opensource.apple.com/source/tcl/tcl-14/tcl/license.terms
|
| 1023 |
+
* Copyright (c) 1988-1993 The Regents of the University of California.
|
| 1024 |
+
* Copyright (c) 1994 Sun Microsystems, Inc.
|
| 1025 |
+
|
| 1026 |
+
This software is copyrighted by the Regents of the University of
|
| 1027 |
+
California, Sun Microsystems, Inc., Scriptics Corporation, ActiveState
|
| 1028 |
+
Corporation and other parties. The following terms apply to all files
|
| 1029 |
+
associated with the software unless explicitly disclaimed in
|
| 1030 |
+
individual files.
|
| 1031 |
+
|
| 1032 |
+
The authors hereby grant permission to use, copy, modify, distribute,
|
| 1033 |
+
and license this software and its documentation for any purpose, provided
|
| 1034 |
+
that existing copyright notices are retained in all copies and that this
|
| 1035 |
+
notice is included verbatim in any distributions. No written agreement,
|
| 1036 |
+
license, or royalty fee is required for any of the authorized uses.
|
| 1037 |
+
Modifications to this software may be copyrighted by their authors
|
| 1038 |
+
and need not follow the licensing terms described here, provided that
|
| 1039 |
+
the new terms are clearly indicated on the first page of each file where
|
| 1040 |
+
they apply.
|
| 1041 |
+
|
| 1042 |
+
IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
|
| 1043 |
+
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
|
| 1044 |
+
ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
|
| 1045 |
+
DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
|
| 1046 |
+
POSSIBILITY OF SUCH DAMAGE.
|
| 1047 |
+
|
| 1048 |
+
THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
|
| 1049 |
+
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
|
| 1050 |
+
FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE
|
| 1051 |
+
IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
|
| 1052 |
+
NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
|
| 1053 |
+
MODIFICATIONS.
|
| 1054 |
+
|
| 1055 |
+
GOVERNMENT USE: If you are acquiring this software on behalf of the
|
| 1056 |
+
U.S. government, the Government shall have only "Restricted Rights"
|
| 1057 |
+
in the software and related documentation as defined in the Federal
|
| 1058 |
+
Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you
|
| 1059 |
+
are acquiring the software on behalf of the Department of Defense, the
|
| 1060 |
+
software shall be classified as "Commercial Computer Software" and the
|
| 1061 |
+
Government shall have only "Restricted Rights" as defined in Clause
|
| 1062 |
+
252.227-7013 (c) (1) of DFARs. Notwithstanding the foregoing, the
|
| 1063 |
+
authors grant the U.S. Government and others acting in its behalf
|
| 1064 |
+
permission to use and distribute the software in accordance with the
|
| 1065 |
+
terms specified in this license.
|
| 1066 |
+
Classifier: Development Status :: 5 - Production/Stable
|
| 1067 |
+
Classifier: Environment :: Console
|
| 1068 |
+
Classifier: Intended Audience :: Science/Research
|
| 1069 |
+
Classifier: License :: OSI Approved :: BSD License
|
| 1070 |
+
Classifier: Operating System :: OS Independent
|
| 1071 |
+
Classifier: Programming Language :: Cython
|
| 1072 |
+
Classifier: Programming Language :: Python
|
| 1073 |
+
Classifier: Programming Language :: Python :: 3
|
| 1074 |
+
Classifier: Programming Language :: Python :: 3 :: Only
|
| 1075 |
+
Classifier: Programming Language :: Python :: 3.11
|
| 1076 |
+
Classifier: Programming Language :: Python :: 3.12
|
| 1077 |
+
Classifier: Programming Language :: Python :: 3.13
|
| 1078 |
+
Classifier: Programming Language :: Python :: 3.14
|
| 1079 |
+
Classifier: Topic :: Scientific/Engineering
|
| 1080 |
+
Project-URL: homepage, https://pandas.pydata.org
|
| 1081 |
+
Project-URL: documentation, https://pandas.pydata.org/docs/
|
| 1082 |
+
Project-URL: repository, https://github.com/pandas-dev/pandas
|
| 1083 |
+
Requires-Python: >=3.11
|
| 1084 |
+
Requires-Dist: numpy>=1.26.0; python_version < "3.14"
|
| 1085 |
+
Requires-Dist: numpy>=2.3.3; python_version >= "3.14"
|
| 1086 |
+
Requires-Dist: python-dateutil>=2.8.2
|
| 1087 |
+
Requires-Dist: tzdata; sys_platform == "win32"
|
| 1088 |
+
Requires-Dist: tzdata; sys_platform == "emscripten"
|
| 1089 |
+
Provides-Extra: test
|
| 1090 |
+
Requires-Dist: hypothesis>=6.116.0; extra == "test"
|
| 1091 |
+
Requires-Dist: pytest>=8.3.4; extra == "test"
|
| 1092 |
+
Requires-Dist: pytest-xdist>=3.6.1; extra == "test"
|
| 1093 |
+
Provides-Extra: pyarrow
|
| 1094 |
+
Requires-Dist: pyarrow>=13.0.0; extra == "pyarrow"
|
| 1095 |
+
Provides-Extra: performance
|
| 1096 |
+
Requires-Dist: bottleneck>=1.4.2; extra == "performance"
|
| 1097 |
+
Requires-Dist: numba>=0.60.0; extra == "performance"
|
| 1098 |
+
Requires-Dist: numexpr>=2.10.2; extra == "performance"
|
| 1099 |
+
Provides-Extra: computation
|
| 1100 |
+
Requires-Dist: scipy>=1.14.1; extra == "computation"
|
| 1101 |
+
Requires-Dist: xarray>=2024.10.0; extra == "computation"
|
| 1102 |
+
Provides-Extra: fss
|
| 1103 |
+
Requires-Dist: fsspec>=2024.10.0; extra == "fss"
|
| 1104 |
+
Provides-Extra: aws
|
| 1105 |
+
Requires-Dist: s3fs>=2024.10.0; extra == "aws"
|
| 1106 |
+
Provides-Extra: gcp
|
| 1107 |
+
Requires-Dist: gcsfs>=2024.10.0; extra == "gcp"
|
| 1108 |
+
Provides-Extra: excel
|
| 1109 |
+
Requires-Dist: odfpy>=1.4.1; extra == "excel"
|
| 1110 |
+
Requires-Dist: openpyxl>=3.1.5; extra == "excel"
|
| 1111 |
+
Requires-Dist: python-calamine>=0.3.0; extra == "excel"
|
| 1112 |
+
Requires-Dist: pyxlsb>=1.0.10; extra == "excel"
|
| 1113 |
+
Requires-Dist: xlrd>=2.0.1; extra == "excel"
|
| 1114 |
+
Requires-Dist: xlsxwriter>=3.2.0; extra == "excel"
|
| 1115 |
+
Provides-Extra: parquet
|
| 1116 |
+
Requires-Dist: pyarrow>=13.0.0; extra == "parquet"
|
| 1117 |
+
Provides-Extra: feather
|
| 1118 |
+
Requires-Dist: pyarrow>=13.0.0; extra == "feather"
|
| 1119 |
+
Provides-Extra: iceberg
|
| 1120 |
+
Requires-Dist: pyiceberg>=0.8.1; extra == "iceberg"
|
| 1121 |
+
Provides-Extra: hdf5
|
| 1122 |
+
Requires-Dist: tables>=3.10.1; extra == "hdf5"
|
| 1123 |
+
Provides-Extra: spss
|
| 1124 |
+
Requires-Dist: pyreadstat>=1.2.8; extra == "spss"
|
| 1125 |
+
Provides-Extra: postgresql
|
| 1126 |
+
Requires-Dist: SQLAlchemy>=2.0.36; extra == "postgresql"
|
| 1127 |
+
Requires-Dist: psycopg2>=2.9.10; extra == "postgresql"
|
| 1128 |
+
Requires-Dist: adbc-driver-postgresql>=1.2.0; extra == "postgresql"
|
| 1129 |
+
Provides-Extra: mysql
|
| 1130 |
+
Requires-Dist: SQLAlchemy>=2.0.36; extra == "mysql"
|
| 1131 |
+
Requires-Dist: pymysql>=1.1.1; extra == "mysql"
|
| 1132 |
+
Provides-Extra: sql-other
|
| 1133 |
+
Requires-Dist: SQLAlchemy>=2.0.36; extra == "sql-other"
|
| 1134 |
+
Requires-Dist: adbc-driver-postgresql>=1.2.0; extra == "sql-other"
|
| 1135 |
+
Requires-Dist: adbc-driver-sqlite>=1.2.0; extra == "sql-other"
|
| 1136 |
+
Provides-Extra: html
|
| 1137 |
+
Requires-Dist: beautifulsoup4>=4.12.3; extra == "html"
|
| 1138 |
+
Requires-Dist: html5lib>=1.1; extra == "html"
|
| 1139 |
+
Requires-Dist: lxml>=5.3.0; extra == "html"
|
| 1140 |
+
Provides-Extra: xml
|
| 1141 |
+
Requires-Dist: lxml>=5.3.0; extra == "xml"
|
| 1142 |
+
Provides-Extra: plot
|
| 1143 |
+
Requires-Dist: matplotlib>=3.9.3; extra == "plot"
|
| 1144 |
+
Provides-Extra: output-formatting
|
| 1145 |
+
Requires-Dist: jinja2>=3.1.5; extra == "output-formatting"
|
| 1146 |
+
Requires-Dist: tabulate>=0.9.0; extra == "output-formatting"
|
| 1147 |
+
Provides-Extra: clipboard
|
| 1148 |
+
Requires-Dist: PyQt5>=5.15.9; extra == "clipboard"
|
| 1149 |
+
Requires-Dist: qtpy>=2.4.2; extra == "clipboard"
|
| 1150 |
+
Provides-Extra: compression
|
| 1151 |
+
Requires-Dist: zstandard>=0.23.0; extra == "compression"
|
| 1152 |
+
Provides-Extra: timezone
|
| 1153 |
+
Requires-Dist: pytz>=2020.1; extra == "timezone"
|
| 1154 |
+
Provides-Extra: all
|
| 1155 |
+
Requires-Dist: adbc-driver-postgresql>=1.2.0; extra == "all"
|
| 1156 |
+
Requires-Dist: adbc-driver-sqlite>=1.2.0; extra == "all"
|
| 1157 |
+
Requires-Dist: beautifulsoup4>=4.12.3; extra == "all"
|
| 1158 |
+
Requires-Dist: bottleneck>=1.4.2; extra == "all"
|
| 1159 |
+
Requires-Dist: fastparquet>=2024.11.0; extra == "all"
|
| 1160 |
+
Requires-Dist: fsspec>=2024.10.0; extra == "all"
|
| 1161 |
+
Requires-Dist: gcsfs>=2024.10.0; extra == "all"
|
| 1162 |
+
Requires-Dist: html5lib>=1.1; extra == "all"
|
| 1163 |
+
Requires-Dist: hypothesis>=6.116.0; extra == "all"
|
| 1164 |
+
Requires-Dist: jinja2>=3.1.5; extra == "all"
|
| 1165 |
+
Requires-Dist: lxml>=5.3.0; extra == "all"
|
| 1166 |
+
Requires-Dist: matplotlib>=3.9.3; extra == "all"
|
| 1167 |
+
Requires-Dist: numba>=0.60.0; extra == "all"
|
| 1168 |
+
Requires-Dist: numexpr>=2.10.2; extra == "all"
|
| 1169 |
+
Requires-Dist: odfpy>=1.4.1; extra == "all"
|
| 1170 |
+
Requires-Dist: openpyxl>=3.1.5; extra == "all"
|
| 1171 |
+
Requires-Dist: psycopg2>=2.9.10; extra == "all"
|
| 1172 |
+
Requires-Dist: pyarrow>=13.0.0; extra == "all"
|
| 1173 |
+
Requires-Dist: pyiceberg>=0.8.1; extra == "all"
|
| 1174 |
+
Requires-Dist: pymysql>=1.1.1; extra == "all"
|
| 1175 |
+
Requires-Dist: PyQt5>=5.15.9; extra == "all"
|
| 1176 |
+
Requires-Dist: pyreadstat>=1.2.8; extra == "all"
|
| 1177 |
+
Requires-Dist: pytest>=8.3.4; extra == "all"
|
| 1178 |
+
Requires-Dist: pytest-xdist>=3.6.1; extra == "all"
|
| 1179 |
+
Requires-Dist: python-calamine>=0.3.0; extra == "all"
|
| 1180 |
+
Requires-Dist: pytz>=2020.1; extra == "all"
|
| 1181 |
+
Requires-Dist: pyxlsb>=1.0.10; extra == "all"
|
| 1182 |
+
Requires-Dist: qtpy>=2.4.2; extra == "all"
|
| 1183 |
+
Requires-Dist: scipy>=1.14.1; extra == "all"
|
| 1184 |
+
Requires-Dist: s3fs>=2024.10.0; extra == "all"
|
| 1185 |
+
Requires-Dist: SQLAlchemy>=2.0.36; extra == "all"
|
| 1186 |
+
Requires-Dist: tables>=3.10.1; extra == "all"
|
| 1187 |
+
Requires-Dist: tabulate>=0.9.0; extra == "all"
|
| 1188 |
+
Requires-Dist: xarray>=2024.10.0; extra == "all"
|
| 1189 |
+
Requires-Dist: xlrd>=2.0.1; extra == "all"
|
| 1190 |
+
Requires-Dist: xlsxwriter>=3.2.0; extra == "all"
|
| 1191 |
+
Requires-Dist: zstandard>=0.23.0; extra == "all"
|
| 1192 |
+
Description-Content-Type: text/markdown
|
| 1193 |
+
|
| 1194 |
+
<picture align="center">
|
| 1195 |
+
<source media="(prefers-color-scheme: dark)" srcset="https://pandas.pydata.org/static/img/pandas_white.svg">
|
| 1196 |
+
<img alt="Pandas Logo" src="https://pandas.pydata.org/static/img/pandas.svg">
|
| 1197 |
+
</picture>
|
| 1198 |
+
|
| 1199 |
+
-----------------
|
| 1200 |
+
|
| 1201 |
+
# pandas: A Powerful Python Data Analysis Toolkit
|
| 1202 |
+
|
| 1203 |
+
| | |
|
| 1204 |
+
| --- | --- |
|
| 1205 |
+
| Testing | [](https://github.com/pandas-dev/pandas/actions/workflows/unit-tests.yml) [](https://codecov.io/gh/pandas-dev/pandas) |
|
| 1206 |
+
| Package | [](https://pypi.org/project/pandas/) [](https://pypi.org/project/pandas/) [](https://anaconda.org/conda-forge/pandas) [](https://anaconda.org/conda-forge/pandas) |
|
| 1207 |
+
| Meta | [](https://numfocus.org) [](https://doi.org/10.5281/zenodo.3509134) [](https://github.com/pandas-dev/pandas/blob/main/LICENSE) [](https://pandas.pydata.org/docs/dev/development/community.html?highlight=slack#community-slack) [](https://insights.linuxfoundation.org/project/pandas-dev-pandas) |
|
| 1208 |
+
|
| 1209 |
+
|
| 1210 |
+
## What is it?
|
| 1211 |
+
|
| 1212 |
+
**pandas** is a Python package that provides fast, flexible, and expressive data
|
| 1213 |
+
structures designed to make working with "relational" or "labeled" data both
|
| 1214 |
+
easy and intuitive. It aims to be the fundamental high-level building block for
|
| 1215 |
+
doing practical, **real-world** data analysis in Python. Additionally, it has
|
| 1216 |
+
the broader goal of becoming **the most powerful and flexible open-source data
|
| 1217 |
+
analysis/manipulation tool available in any language**. It is already well on
|
| 1218 |
+
its way towards this goal.
|
| 1219 |
+
|
| 1220 |
+
## Table of Contents
|
| 1221 |
+
|
| 1222 |
+
- [Main Features](#main-features)
|
| 1223 |
+
- [Where to get it](#where-to-get-it)
|
| 1224 |
+
- [Dependencies](#dependencies)
|
| 1225 |
+
- [Installation from sources](#installation-from-sources)
|
| 1226 |
+
- [License](#license)
|
| 1227 |
+
- [Documentation](#documentation)
|
| 1228 |
+
- [Background](#background)
|
| 1229 |
+
- [Getting Help](#getting-help)
|
| 1230 |
+
- [Discussion and Development](#discussion-and-development)
|
| 1231 |
+
- [Contributing to pandas](#contributing-to-pandas)
|
| 1232 |
+
|
| 1233 |
+
## Main Features
|
| 1234 |
+
Here are just a few of the things that pandas does well:
|
| 1235 |
+
|
| 1236 |
+
- Easy handling of [**missing data**][missing-data] (represented as
|
| 1237 |
+
`NaN`, `NA`, or `NaT`) in floating point as well as non-floating point data
|
| 1238 |
+
- Size mutability: columns can be [**inserted and
|
| 1239 |
+
deleted**][insertion-deletion] from DataFrame and higher dimensional
|
| 1240 |
+
objects
|
| 1241 |
+
- Automatic and explicit [**data alignment**][alignment]: objects can
|
| 1242 |
+
be explicitly aligned to a set of labels, or the user can simply
|
| 1243 |
+
ignore the labels and let `Series`, `DataFrame`, etc. automatically
|
| 1244 |
+
align the data for you in computations
|
| 1245 |
+
- Powerful, flexible [**group by**][groupby] functionality to perform
|
| 1246 |
+
split-apply-combine operations on data sets, for both aggregating
|
| 1247 |
+
and transforming data
|
| 1248 |
+
- Make it [**easy to convert**][conversion] ragged,
|
| 1249 |
+
differently-indexed data in other Python and NumPy data structures
|
| 1250 |
+
into DataFrame objects
|
| 1251 |
+
- Intelligent label-based [**slicing**][slicing], [**fancy
|
| 1252 |
+
indexing**][fancy-indexing], and [**subsetting**][subsetting] of
|
| 1253 |
+
large data sets
|
| 1254 |
+
- Intuitive [**merging**][merging] and [**joining**][joining] data
|
| 1255 |
+
sets
|
| 1256 |
+
- Flexible [**reshaping**][reshape] and [**pivoting**][pivot-table] of
|
| 1257 |
+
data sets
|
| 1258 |
+
- [**Hierarchical**][mi] labeling of axes (possible to have multiple
|
| 1259 |
+
labels per tick)
|
| 1260 |
+
- Robust I/O tools for loading data from [**flat files**][flat-files]
|
| 1261 |
+
(CSV and delimited), [**Excel files**][excel], [**databases**][db],
|
| 1262 |
+
and saving/loading data from the ultrafast [**HDF5 format**][hdfstore]
|
| 1263 |
+
- [**Time series**][timeseries]-specific functionality: date range
|
| 1264 |
+
generation and frequency conversion, moving window statistics,
|
| 1265 |
+
date shifting and lagging
|
| 1266 |
+
|
| 1267 |
+
|
| 1268 |
+
[missing-data]: https://pandas.pydata.org/pandas-docs/stable/user_guide/missing_data.html
|
| 1269 |
+
[insertion-deletion]: https://pandas.pydata.org/pandas-docs/stable/user_guide/dsintro.html#column-selection-addition-deletion
|
| 1270 |
+
[alignment]: https://pandas.pydata.org/pandas-docs/stable/user_guide/dsintro.html?highlight=alignment#intro-to-data-structures
|
| 1271 |
+
[groupby]: https://pandas.pydata.org/pandas-docs/stable/user_guide/groupby.html#group-by-split-apply-combine
|
| 1272 |
+
[conversion]: https://pandas.pydata.org/pandas-docs/stable/user_guide/dsintro.html#dataframe
|
| 1273 |
+
[slicing]: https://pandas.pydata.org/pandas-docs/stable/user_guide/indexing.html#slicing-ranges
|
| 1274 |
+
[fancy-indexing]: https://pandas.pydata.org/pandas-docs/stable/user_guide/advanced.html#advanced
|
| 1275 |
+
[subsetting]: https://pandas.pydata.org/pandas-docs/stable/user_guide/indexing.html#boolean-indexing
|
| 1276 |
+
[merging]: https://pandas.pydata.org/pandas-docs/stable/user_guide/merging.html#database-style-dataframe-or-named-series-joining-merging
|
| 1277 |
+
[joining]: https://pandas.pydata.org/pandas-docs/stable/user_guide/merging.html#joining-on-index
|
| 1278 |
+
[reshape]: https://pandas.pydata.org/pandas-docs/stable/user_guide/reshaping.html
|
| 1279 |
+
[pivot-table]: https://pandas.pydata.org/pandas-docs/stable/user_guide/reshaping.html
|
| 1280 |
+
[mi]: https://pandas.pydata.org/pandas-docs/stable/user_guide/indexing.html#hierarchical-indexing-multiindex
|
| 1281 |
+
[flat-files]: https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#csv-text-files
|
| 1282 |
+
[excel]: https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#excel-files
|
| 1283 |
+
[db]: https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#sql-queries
|
| 1284 |
+
[hdfstore]: https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#hdf5-pytables
|
| 1285 |
+
[timeseries]: https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#time-series-date-functionality
|
| 1286 |
+
|
| 1287 |
+
## Where to get it
|
| 1288 |
+
The source code is currently hosted on GitHub at:
|
| 1289 |
+
https://github.com/pandas-dev/pandas
|
| 1290 |
+
|
| 1291 |
+
Binary installers for the latest released version are available at the [Python
|
| 1292 |
+
Package Index (PyPI)](https://pypi.org/project/pandas) and on [Conda](https://anaconda.org/conda-forge/pandas).
|
| 1293 |
+
|
| 1294 |
+
```sh
|
| 1295 |
+
# conda
|
| 1296 |
+
conda install -c conda-forge pandas
|
| 1297 |
+
```
|
| 1298 |
+
|
| 1299 |
+
```sh
|
| 1300 |
+
# or PyPI
|
| 1301 |
+
pip install pandas
|
| 1302 |
+
```
|
| 1303 |
+
|
| 1304 |
+
The list of changes to pandas between each release can be found
|
| 1305 |
+
[here](https://pandas.pydata.org/pandas-docs/stable/whatsnew/index.html). For full
|
| 1306 |
+
details, see the commit logs at https://github.com/pandas-dev/pandas.
|
| 1307 |
+
|
| 1308 |
+
## Dependencies
|
| 1309 |
+
- [NumPy - Adds support for large, multi-dimensional arrays, matrices and high-level mathematical functions to operate on these arrays](https://www.numpy.org)
|
| 1310 |
+
- [python-dateutil - Provides powerful extensions to the standard datetime module](https://dateutil.readthedocs.io/en/stable/index.html)
|
| 1311 |
+
- [tzdata - Provides an IANA time zone database](https://tzdata.readthedocs.io/en/latest/) (Only required on Windows/Emscripten)
|
| 1312 |
+
|
| 1313 |
+
See the [full installation instructions](https://pandas.pydata.org/pandas-docs/stable/install.html#dependencies) for minimum supported versions of required, recommended and optional dependencies.
|
| 1314 |
+
|
| 1315 |
+
## Installation from sources
|
| 1316 |
+
To install pandas from source you need [Cython](https://cython.org/) in addition to the normal
|
| 1317 |
+
dependencies above. Cython can be installed from PyPI:
|
| 1318 |
+
|
| 1319 |
+
```sh
|
| 1320 |
+
pip install cython
|
| 1321 |
+
```
|
| 1322 |
+
|
| 1323 |
+
In the `pandas` directory (same one where you found this file after
|
| 1324 |
+
cloning the git repo), execute:
|
| 1325 |
+
|
| 1326 |
+
```sh
|
| 1327 |
+
pip install .
|
| 1328 |
+
```
|
| 1329 |
+
|
| 1330 |
+
or for installing in [development mode](https://pip.pypa.io/en/latest/cli/pip_install/#install-editable):
|
| 1331 |
+
|
| 1332 |
+
|
| 1333 |
+
```sh
|
| 1334 |
+
python -m pip install -ve . --no-build-isolation --config-settings editable-verbose=true
|
| 1335 |
+
```
|
| 1336 |
+
|
| 1337 |
+
See the full instructions for [installing from source](https://pandas.pydata.org/docs/dev/development/contributing_environment.html).
|
| 1338 |
+
|
| 1339 |
+
## License
|
| 1340 |
+
[BSD 3](LICENSE)
|
| 1341 |
+
|
| 1342 |
+
## Documentation
|
| 1343 |
+
The official documentation is hosted on [PyData.org](https://pandas.pydata.org/pandas-docs/stable/).
|
| 1344 |
+
|
| 1345 |
+
## Background
|
| 1346 |
+
Work on ``pandas`` started at [AQR](https://www.aqr.com/) (a quantitative hedge fund) in 2008 and
|
| 1347 |
+
has been under active development since then.
|
| 1348 |
+
|
| 1349 |
+
## Getting Help
|
| 1350 |
+
|
| 1351 |
+
For usage questions, the best place to go to is [Stack Overflow](https://stackoverflow.com/questions/tagged/pandas).
|
| 1352 |
+
Further, general questions and discussions can also take place on the [pydata mailing list](https://groups.google.com/forum/?fromgroups#!forum/pydata).
|
| 1353 |
+
|
| 1354 |
+
## Discussion and Development
|
| 1355 |
+
Most development discussions take place on GitHub in this repo, via the [GitHub issue tracker](https://github.com/pandas-dev/pandas/issues).
|
| 1356 |
+
|
| 1357 |
+
Further, the [pandas-dev mailing list](https://mail.python.org/mailman/listinfo/pandas-dev) can also be used for specialized discussions or design issues, and a [Slack channel](https://pandas.pydata.org/docs/dev/development/community.html?highlight=slack#community-slack) is available for quick development related questions.
|
| 1358 |
+
|
| 1359 |
+
There are also frequent [community meetings](https://pandas.pydata.org/docs/dev/development/community.html#community-meeting) for project maintainers open to the community as well as monthly [new contributor meetings](https://pandas.pydata.org/docs/dev/development/community.html#new-contributor-meeting) to help support new contributors.
|
| 1360 |
+
|
| 1361 |
+
Additional information on the communication channels can be found on the [contributor community](https://pandas.pydata.org/docs/development/community.html) page.
|
| 1362 |
+
|
| 1363 |
+
## Contributing to pandas
|
| 1364 |
+
|
| 1365 |
+
[](https://www.codetriage.com/pandas-dev/pandas)
|
| 1366 |
+
|
| 1367 |
+
All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.
|
| 1368 |
+
|
| 1369 |
+
A detailed overview on how to contribute can be found in the **[contributing guide](https://pandas.pydata.org/docs/dev/development/contributing.html)**.
|
| 1370 |
+
|
| 1371 |
+
If you are simply looking to start working with the pandas codebase, navigate to the [GitHub "issues" tab](https://github.com/pandas-dev/pandas/issues) and start looking through interesting issues. There are a number of issues listed under [Docs](https://github.com/pandas-dev/pandas/issues?q=is%3Aissue%20state%3Aopen%20label%3ADocs%20sort%3Aupdated-desc) and [good first issue](https://github.com/pandas-dev/pandas/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22%20sort%3Aupdated-desc) where you could start out.
|
| 1372 |
+
|
| 1373 |
+
You can also triage issues which may include reproducing bug reports, or asking for vital information such as version numbers or reproduction instructions. If you would like to start triaging issues, one easy way to get started is to [subscribe to pandas on CodeTriage](https://www.codetriage.com/pandas-dev/pandas).
|
| 1374 |
+
|
| 1375 |
+
Or maybe through using pandas you have an idea of your own or are looking for something in the documentation and thinking ‘this can be improved’... you can do something about it!
|
| 1376 |
+
|
| 1377 |
+
Feel free to ask questions on the [mailing list](https://groups.google.com/forum/?fromgroups#!forum/pydata) or on [Slack](https://pandas.pydata.org/docs/dev/development/community.html?highlight=slack#community-slack).
|
| 1378 |
+
|
| 1379 |
+
As contributors and maintainers to this project, you are expected to abide by pandas' code of conduct. More information can be found at: [Contributor Code of Conduct](https://github.com/pandas-dev/.github/blob/master/CODE_OF_CONDUCT.md)
|
| 1380 |
+
|
| 1381 |
+
<hr>
|
| 1382 |
+
|
| 1383 |
+
[Go to Top](#table-of-contents)
|
.cache/pip/http-v2/8/f/0/a/d/8f0ad583652318494c12da41e4d30ff6225ec73d448a0754a0a7e898
ADDED
|
Binary file (1.9 kB). View file
|
|
|
.cache/pip/http-v2/9/0/6/7/9/906797ab7b3f56fdd856b186be66ce1ad5fb99862a404c1091a707b6
ADDED
|
Binary file (1.89 kB). View file
|
|
|
.cache/pip/http-v2/9/0/6/7/9/906797ab7b3f56fdd856b186be66ce1ad5fb99862a404c1091a707b6.body
ADDED
|
Binary file (78.4 kB). View file
|
|
|