Metadata-Version: 2.3
Name: openmind-hub
Version: 0.7.1
Summary: Hub client SDK for openMind
Project-URL: Homepage, https://gitee.com/openmind-ai/openmind-hub
Project-URL: Repository, https://gitee.com/openmind-ai/openmind-hub
Author-email: The openMind Team <dev@public.openmind.cn>
License:                      木兰宽松许可证, 第2版
        
           木兰宽松许可证， 第2版
           2020年1月 http://license.coscl.org.cn/MulanPSL2
        
        
           您对“软件”的复制、使用、修改及分发受木兰宽松许可证，第2版（“本许可证”）的如下条款的约束：
        
           0. 定义
        
              “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。
        
              “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。
        
              “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。
        
              “法人实体”是指提交贡献的机构及其“关联实体”。
        
              “关联实体”是指，对“本许可证”下的行为方而言，控制、受控制或与其共同受控制的机构，此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。
        
           1. 授予版权许可
        
              每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可，您可以复制、使用、修改、分发其“贡献”，不论修改与否。
        
           2. 授予专利许可
        
              每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的（根据本条规定撤销除外）专利许可，供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求，不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地，就“软件”或其中的“贡献”对任何人发起专利侵权诉讼（包括反诉或交叉诉讼）或其他专利维权行动，指控其侵犯专利权，则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。
        
           3. 无商标许可
        
              “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可，但您为满足第4条规定的声明义务而必须使用除外。
        
           4. 分发限制
        
              您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发，不论修改与否，但您必须向接收者提供“本许可证”的副本，并保留“软件”中的版权、商标、专利及免责声明。
        
           5. 免责声明与责任限制
        
              “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下，“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任，不论因何种原因导致或者基于何种法律理论，即使其曾被建议有此种损失的可能性。
        
           6. 语言
              “本许可证”以中英文双语表述，中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致，以中文版为准。
        
           条款结束
        
           如何将木兰宽松许可证，第2版，应用到您的软件
        
           如果您希望将木兰宽松许可证，第2版，应用到您的新软件，为了方便接收者查阅，建议您完成如下三步：
        
              1， 请您补充如下声明中的空白，包括软件名、软件的首次发表年份以及您作为版权人的名字；
        
              2， 请您在软件包的一级目录下创建以“LICENSE”为名的文件，将整个许可证文本放入该文件中；
        
              3， 请将如下声明文本放入每个源文件的头部注释中。
        
           Copyright (c) [Year] [name of copyright holder]
           [Software Name] is licensed under Mulan PSL v2.
           You can use this software according to the terms and conditions of the Mulan PSL v2.
           You may obtain a copy of Mulan PSL v2 at:
                    http://license.coscl.org.cn/MulanPSL2
           THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
           See the Mulan PSL v2 for more details.
        
        
                             Mulan Permissive Software License，Version 2
        
           Mulan Permissive Software License，Version 2 (Mulan PSL v2)
           January 2020 http://license.coscl.org.cn/MulanPSL2
        
           Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions:
        
           0. Definition
        
              Software means the program and related documents which are licensed under this License and comprise all Contribution(s).
        
              Contribution means the copyrightable work licensed by a particular Contributor under this License.
        
              Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License.
        
              Legal Entity means the entity making a Contribution and all its Affiliates.
        
              Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity.
        
           1. Grant of Copyright License
        
              Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not.
        
           2. Grant of Patent License
        
              Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken.
        
           3. No Trademark License
        
              No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4.
        
           4. Distribution Restriction
        
              You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software.
        
           5. Disclaimer of Warranty and Limitation of Liability
        
              THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
        
           6. Language
        
              THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL.
        
           END OF THE TERMS AND CONDITIONS
        
           How to Apply the Mulan Permissive Software License，Version 2 (Mulan PSL v2) to Your Software
        
              To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps:
        
              i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner;
        
              ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package;
        
              iii Attach the statement to the appropriate annotated syntax at the beginning of each source file.
        
        
           Copyright (c) [Year] [name of copyright holder]
           [Software Name] is licensed under Mulan PSL v2.
           You can use this software according to the terms and conditions of the Mulan PSL v2.
           You may obtain a copy of Mulan PSL v2 at:
                       http://license.coscl.org.cn/MulanPSL2
           THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
           See the Mulan PSL v2 for more details.
License-File: LICENSE
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Mulan Permissive Software License v2 (MulanPSL-2.0)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: <3.11,>=3.8
Requires-Dist: filelock>=3.14.0
Requires-Dist: fsspec>=2024.2.0
Requires-Dist: jinja2>=3.1.4
Requires-Dist: pyyaml>=6.0.1
Requires-Dist: requests==2.32.2
Requires-Dist: tqdm>=4.66.4
Requires-Dist: urllib3>=2.0.0
Provides-Extra: all
Requires-Dist: openi>=2.0.2; extra == 'all'
Provides-Extra: lint
Requires-Dist: black; extra == 'lint'
Requires-Dist: ruff; extra == 'lint'
Provides-Extra: openi
Requires-Dist: openi>=2.0.2; extra == 'openi'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: testtools; extra == 'test'
Description-Content-Type: text/markdown

# openMind Hub Client

## 简介

openMind Hub Client可以帮助您在不离开开发环境的情况下与社区进行交互。您可以轻松创建和管理仓库，下载和上传文件以及从模型库获取有用的模型和数据集元数据。

## 安装

关于openMind Hub Client的安装步骤，推荐用户参考[《安装》](./docs/zh/install.md)文档，以确保顺利并正确地完成安装过程。

## 下载文件

例如，下载[t5_small](https://modelers.cn/models/PyTorch-NPU/t5_small/)模型配置文件：

```py
from openmind_hub import om_hub_download

om_hub_download(repo_id="PyTorch-NPU/t5_small", filename="config.json")
```

详见[《下载指南》](./docs/zh/basic_tutorial/download.md)。

## 访问令牌

访问私有仓库资源、创建仓库和上传文件等场景都需要使用访问令牌（即token）才能与社区进行交互。请[创建访问令牌](https://modelers.cn/my/tokens)并妥善保存，令牌内容仅会在创建时显示。

## 上传文件

使用`upload_folder`为您的仓库上传文件，示例如下：

```py
from openmind_hub import upload_folder
upload_folder(
    repo_id="owner/repo",
    folder_path="./folder_to_upload",
    token="xxx",
)
```

+ `token`：对目标仓库具有可写权限的访问令牌，必选。
+ `repo_id`：文件要上传到的仓库，必选。
+ `folder_path`：要上传目录的绝对路径或相对路径，上传的内容不包含该目录本身，必选。支持字符串或Path类型，如：`"./folder"`或`Path("./folder")`。

详见[《上传文件》](./docs/zh/basic_tutorial/upload.md)。

## 贡献

1. 在提交PR之前，请确保所有测试都通过。首先在本地运行如下命令。

    ```shell
    # The scripts below run on system default python version by default. If you want to use other python version, set the env
    # PY_VERSION. For example, `PY_VERSION=3.10 ./ci/lint.sh`
    # Lint check
    ./ci/lint.sh
    # Unit test
    ./ci/unit_test.sh
    # Functional test, Please generate the HUB_TOKEN by yourself and use it privatelly.
    HUB_TOKEN=your_hub_token ./ci/functional_test.sh
    ```

2. 当您推送或更新PR（Pull Request）后，系统将自动触发CI（持续集成）构建和测试流程。若所有CI构建和测试均顺利通过，`ci-success`标记将自动添加到您的PR中。然而，若出现CI故障，您可以点击CI日志链接以详细查看失败原因，并在本地进行必要的修复。一旦您完成了修复并希望重新运行CI作业，只需在PR中留下评论`/recheck`即可。

## 安全声明

为保障使用过程安全，推荐用户参考[《安全声明》](./security_statement.md)了解相关安全信息，进行必要的安全加固。