1173 Add dump env helper #1177

Wauplin · 2022-11-09T17:17:43Z

Resolve #1173. Should ease some debugging of issues from users.

TODO:

update issue template ?
is there any other relevant information to paste ?

Inspired by existing work in transformers diffusers (thanks @mariosasko)

In terminal

➜  huggingface-cli env

Copy-and-paste the text below in your GitHub issue.

- huggingface_hub version: 0.11.0.dev0
- Platform: Linux-5.15.0-52-generic-x86_64-with-glibc2.35
- Python version: 3.10.6
- Running in iPython ?: No
- Running in notebook ?: False
- Running in Google Colab ?: False
- Token path ?: /home/wauplin/.huggingface/token
- Has saved token ?: True
- Token type: Personal token
- Who am I ?: Wauplin
- Configured git credential helpers: 
- FastAI: N/A
- Tensorflow: 2.9.1
- Torch: 1.12.1
- Jinja2: 3.1.2
- Graphviz: 0.20.1
- Pydot: 1.4.2

From python

from huggingface_hub import dump_environment_info

dump_environment_info()

Output from ipython in terminal:


Copy-and-paste the text below in your GitHub issue.

- huggingface_hub version: 0.11.0.dev0
- Platform: Linux-5.15.0-52-generic-x86_64-with-glibc2.35
- Python version: 3.10.6
- Running in iPython ?: Yes
- iPython shell: TerminalInteractiveShell
- Running in notebook ?: False
- Running in Google Colab ?: False
- Token path ?: /home/wauplin/.huggingface/token
- Has saved token ?: True
- Token type: Personal token
- Who am I ?: Wauplin
- Configured git credential helpers: 
- FastAI: N/A
- Tensorflow: 2.9.1
- Torch: 1.12.1
- Jinja2: 3.1.2
- Graphviz: 0.20.1
- Pydot: 1.4.2

HuggingFaceDocBuilder · 2022-11-09T17:20:48Z

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

codecov · 2022-11-09T17:35:00Z

Codecov Report

Base: 84.82% // Head: 83.87% // Decreases project coverage by -0.94% ⚠️

Coverage data is based on head (1716d88) compared to base (fb3f9cb).
Patch coverage: 5.88% of modified lines in pull request are covered.

❗ Current head 1716d88 differs from pull request most recent head 4de6884. Consider uploading reports for the commit 4de6884 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1177      +/-   ##
==========================================
- Coverage   84.82%   83.87%   -0.95%     
==========================================
  Files          42       43       +1     
  Lines        4210     4261      +51     
==========================================
+ Hits         3571     3574       +3     
- Misses        639      687      +48

Impacted Files	Coverage Δ
src/huggingface_hub/commands/env.py	`0.00% <0.00%> (ø)`
src/huggingface_hub/commands/huggingface_cli.py	`0.00% <0.00%> (ø)`
src/huggingface_hub/utils/__init__.py	`100.00% <ø> (ø)`
src/huggingface_hub/utils/_runtime.py	`61.90% <8.33%> (-27.96%)`	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

LysandreJik

LGTM! You could also edit the issue templates to request the command to be run before opening an issue. Right now it asks for the versions, but it would be simpler to just point to the command

osanseviero

Thanks! Agree on changing the templates

osanseviero · 2022-11-10T05:30:01Z

src/huggingface_hub/utils/_runtime.py

+    info["Has saved token ?"] = token is not None
+    if token is not None:
+        info["Token type"] = (
+            "Organization token" if token.startswith("hf_org") else "Personal token"


I don't think we can ever have an organization token saved right? The login fails for those (see https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/_login.py#L225 )

Yep true, I'll remove it. Thanks :)

yes i was going to comment the same. Org tokens are on their way to deprecation anyways

HuggingFaceDocBuilder · 2022-11-10T08:03:10Z

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

Wauplin · 2022-11-10T08:04:10Z

Thanks both for the review !

You could also edit the issue templates to request the command to be run before opening an issue.

Yes that's what I meant by " update issue template ?" in the todo list of the PR but it wasn't so clear 😄

Anyway, I updated it and will merge when CI is green. Hope it will prove to be useful in the future :)

HuggingFaceDocBuilder · 2022-11-10T08:07:04Z

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

julien-c · 2022-11-15T08:17:58Z

.github/ISSUE_TEMPLATE/bug-report.yml

+        huggingface-cli env
+        ```
+
+        If your are working in a notebook, please run it in a code cell:


julien-c · 2022-11-15T08:19:10Z

src/huggingface_hub/utils/_runtime.py

@@ -177,3 +179,53 @@ def is_google_colab() -> bool:
    Taken from https://stackoverflow.com/a/63519730.
    """
    return _is_google_colab
+
+
+def dump_environment_info() -> Dict[str, Any]:


(nit) maybe link to transformers diffusers implementations for reference

julien-c

lgtm!

Wauplin added 2 commits November 9, 2022 18:06

Add a huggingface-cli env command

7b63884

update print info

1716d88

Wauplin requested review from LysandreJik and osanseviero November 9, 2022 17:17

LysandreJik approved these changes Nov 9, 2022

View reviewed changes

osanseviero approved these changes Nov 10, 2022

View reviewed changes

update bug report template

4de6884

make quality

15b6996

Wauplin merged commit 587eea0 into main Nov 10, 2022

Wauplin deleted the 1173-add-dump-env-helper branch November 10, 2022 08:18

julien-c reviewed Nov 15, 2022

View reviewed changes

.github/ISSUE_TEMPLATE/bug-report.yml

huggingface-cli env

```

If your are working in a notebook, please run it in a code cell:

Copy link

Member

julien-c Nov 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*you

julien-c reviewed Nov 15, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

1173 Add dump env helper #1177

1173 Add dump env helper #1177

Wauplin commented Nov 9, 2022 •

edited

HuggingFaceDocBuilder commented Nov 9, 2022

codecov bot commented Nov 9, 2022 •

edited

LysandreJik left a comment

osanseviero left a comment

osanseviero Nov 10, 2022

Wauplin Nov 10, 2022

julien-c Nov 15, 2022

HuggingFaceDocBuilder commented Nov 10, 2022

Wauplin commented Nov 10, 2022

HuggingFaceDocBuilder commented Nov 10, 2022

julien-c Nov 15, 2022

julien-c Nov 15, 2022

julien-c left a comment

1173 Add dump env helper #1177

1173 Add dump env helper #1177

Conversation

Wauplin commented Nov 9, 2022 • edited

In terminal

From python

HuggingFaceDocBuilder commented Nov 9, 2022

codecov bot commented Nov 9, 2022 • edited

Codecov Report

LysandreJik left a comment

Choose a reason for hiding this comment

osanseviero left a comment

Choose a reason for hiding this comment

osanseviero Nov 10, 2022

Choose a reason for hiding this comment

Wauplin Nov 10, 2022

Choose a reason for hiding this comment

julien-c Nov 15, 2022

Choose a reason for hiding this comment

HuggingFaceDocBuilder commented Nov 10, 2022

Wauplin commented Nov 10, 2022

HuggingFaceDocBuilder commented Nov 10, 2022

julien-c Nov 15, 2022

Choose a reason for hiding this comment

julien-c Nov 15, 2022

Choose a reason for hiding this comment

julien-c left a comment

Choose a reason for hiding this comment

Wauplin commented Nov 9, 2022 •

edited

codecov bot commented Nov 9, 2022 •

edited