Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make it clearer that the library is provided as-is and is not meant #13

Merged
merged 2 commits into from
May 16, 2023
+52 −1
Merged

Make it clearer that the library is provided as-is and is not meant #13

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96414a3
Make it clearer that the library is provided as-is and is not meant
Narsil May 16, 2023
46a3d54
Update .github/ISSUE_TEMPLATE/bug-report.yml
Narsil May 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: "\U0001F41B Bug Report"
description: Submit a bug report to help us improve transformers
body:
- type: textarea
id: system-info
attributes:
label: System Info
description: Please make sure the bug you are describing is not a general
usability thing. This library is provided *as-is*, not as a general
usability tool. Issues need to concern the actual result of the downloaded
or uploaded files.
placeholder: hf_transfer version, platform, python version, huggingface_hub version...
validations:
required: true
- type: textarea
id: reproduction
validations:
required: true
attributes:
label: Reproduction
description: |
Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet.
If you have code snippets, error messages, stack traces please provide them here as well.
Important! Use code tags to correctly format your code. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting
Do not use screenshots, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code.

placeholder: |
Steps to reproduce the behavior:

1.
2.
3.


- type: textarea
id: expected-behavior
validations:
required: true
attributes:
label: Expected behavior
description: "A clear and concise description of what you would expect to happen."
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
blank_issues_enabled: true
version: 2.1
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,15 @@

Speed up file transfers with the Hub.

Supports download and upload.
# DISCLAIMER

This library is a power user tool, to go beyond `~500MB/s` on very high bandwidth
network, where Python cannot cap out the available bandwidth.

This is *not* meant to be a general usability tool.
It purposefully lacks progressbars and comes generally as-is.
Copy link
Member

Choose a reason for hiding this comment

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

Why can't a power user have a progress bar 😅

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Because it can slow things down, and I don't want to spend time investigating why, nor maintaining it.

If it was meant for general use, I'd do it. But it's not (at least I don't).


Please file issues *only* if there's an issue on the underlying downloaded file.

## Contributing

Expand Down