From 96414a377e1932c8a11d835c73e566c5371a187b Mon Sep 17 00:00:00 2001 From: Nicolas Patry Date: Tue, 16 May 2023 10:06:43 +0200 Subject: [PATCH 1/2] Make it clearer that the library is provided as-is and is not meant for general use. --- .github/ISSUE_TEMPLATE/bug-report.yml | 41 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 2 ++ README.md | 10 ++++++- 3 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..28cf883 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -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." diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..e647772 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,2 @@ +blank_issues_enabled: true +version: 2.1 diff --git a/README.md b/README.md index 28c2aee..83a22cd 100644 --- a/README.md +++ b/README.md @@ -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. + +Please file issues *only* if there's an issue on the underlying downloaded file. ## Contributing From 46a3d545370ba338d09b6e4d144e0a65bfe8b01b Mon Sep 17 00:00:00 2001 From: Nicolas Patry Date: Tue, 16 May 2023 10:20:54 +0200 Subject: [PATCH 2/2] Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: Lucain --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 28cf883..3a93cdb 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,5 +1,5 @@ name: "\U0001F41B Bug Report" -description: Submit a bug report to help us improve transformers +description: Submit a bug report to help us improve hf_transfer body: - type: textarea id: system-info