.. raw:: html

<p align="center">
    <a href="#readme">
        <img alt="logo" width="40%" src="https://i.imgur.com/yi6jwST.png">
    </a>
</p>
<p align="center">
    <a href="https://pypi.python.org/pypi/malaya"><img alt="Pypi版本" src="https://badge.fury.io/py/malaya.svg"></a>
    <a href="https://pypi.python.org/pypi/malaya"><img alt="Python3版本" src="https://img.shields.io/pypi/pyversions/malaya.svg"></a>
    <a href="https://github.com/huseinzol05/Malaya/blob/master/LICENSE"><img alt="MIT许可证" src="https://img.shields.io/github/license/huseinzol05/malaya.svg?color=blue"></a>
    <a href="https://malaya.readthedocs.io/"><img alt="文档" src="https://oss.gittoolsai.com/images/malaysia-ai_malaya_readme_6bf48b3e9a6d.png"></a>
    <a href="https://pepy.tech/project/malaya"><img alt="总统计" src="https://oss.gittoolsai.com/images/malaysia-ai_malaya_readme_4a01beed10ce.png"></a>
    <a href="https://pepy.tech/project/malaya"><img alt="月下载量统计" src="https://oss.gittoolsai.com/images/malaysia-ai_malaya_readme_4a01beed10ce.png/month"></a>
    <a href="https://discord.gg/J3aSWyMy9A"><img alt="Discord" src="https://img.shields.io/badge/discord%20-Malaysia_AI-rgb(118,138,212).svg"></a>
</p>

=========

Malaya 是一个基于 PyTorch 的马来语自然语言处理工具库。

文档

完整的文档可在 https://malaya.readthedocs.io/ 获取。

从 PyPI 安装

::

$ pip install malaya

这将自动安装所有依赖项，但不包括 PyTorch。因此，您可以选择适合自己的 CPU 或 GPU 版本的 PyTorch。

仅支持 Python >= 3.6.0 和 PyTorch >= 1.10。

如果您是 Windows 用户，请务必阅读 https://malaya.readthedocs.io/en/latest/running-on-windows.html。

开发版

从 master 分支安装：

::

$ pip install git+https://github.com/huseinzol05/malaya.git

我们建议使用 virtualenv 进行开发。

文档可在 https://malaya.readthedocs.io/en/latest/ 查看。

预训练模型

Malaya 还发布了马来西亚语的预训练模型，详情请访问 https://huggingface.co/mesolitica。

参考文献

如果您在研究中使用了我们的软件，请引用以下内容：

::

@misc{Malaya, 马来语自然语言处理工具库，基于 PyTorch, author = {Husein, Zolkepli}, title = {Malaya}, year = {2018}, publisher = {GitHub}, journal = {GitHub仓库}, howpublished = {\url{https://github.com/mesolitica/malaya}} }

致谢

感谢以下单位和个人：

1. KeyReply <https://www.keyreply.com/>_ 提供的私有 V100 云资源。

.. raw:: html

<a href="#readme">
    <img alt="logo" width="20%" src="https://oss.gittoolsai.com/images/malaysia-ai_malaya_readme_beeb365a039e.png">
</a>

2. Nvidia <https://www.nvidia.com/en-us/>_ 提供的 Azure 信用额度。

.. raw:: html

<a href="#readme">
    <img alt="logo" width="20%" src="https://oss.gittoolsai.com/images/malaysia-ai_malaya_readme_0045867b7b09.png">
</a>

3. TensorFlow Research Cloud <https://www.tensorflow.org/tfrc>_ 提供的免费 TPU 访问权限。

.. raw:: html

<a href="https://www.tensorflow.org/tfrc">
    <img alt="logo" width="20%" src="https://oss.gittoolsai.com/images/malaysia-ai_malaya_readme_0008ab4c4a0f.png">
</a>

贡献

感谢您对本库的贡献，这对我们帮助很大。如果您有任何建议或想以其他形式参与贡献，请随时与我联系！我们欢迎任何形式的贡献，不仅仅是代码！

.. raw:: html

<a href="#readme">
    <img alt="logo" width="30%" src="https://oss.gittoolsai.com/images/malaysia-ai_malaya_readme_456658af3076.png">
</a>

Malaya 快速上手指南

Malaya 是一个基于 PyTorch 构建的马来语（Bahasa Malaysia）自然语言处理工具包。本指南将帮助中国开发者快速完成环境配置并开始使用。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux、macOS 或 Windows（Windows 用户建议查阅官方文档中的特定运行说明）。
• Python 版本：>= 3.6.0
• 核心依赖：PyTorch >= 1.10
  • 注意：安装脚本不会自动安装 PyTorch，以便您可以自由选择适合本地硬件的 CPU 或 GPU 版本。

安装步骤

1. 安装 PyTorch

根据您的硬件环境（是否拥有 NVIDIA GPU），前往 PyTorch 官网 获取对应的安装命令并执行。

国内加速建议：如果下载速度较慢，可使用清华源或阿里源进行加速。例如使用 pip 安装时添加 -i https://pypi.tuna.tsinghua.edu.cn/simple 参数。

2. 安装 Malaya

通过 PyPI 安装稳定版：

pip install malaya

如果您希望体验最新开发功能，可以从 GitHub 主分支安装：

pip install git+https://github.com/huseinzol05/Malaya.git

提示：建议在虚拟环境（virtualenv 或 conda）中进行安装和开发，以避免依赖冲突。

基本使用

安装完成后，即可在 Python 中导入并使用 Malaya 处理马来语文本。以下是一个简单的文本分类示例：

import malaya

# 加载预训练的马来语情感分析模型
model = malaya.sentiment.analysis()

# 待分析的马来语文本
text = "Saya sangat gembira dengan perkhidmatan ini."

# 进行预测
result = model.predict(text)

print(result)
# 输出示例: {'negative': 0.01, 'neutral': 0.04, 'positive': 0.95}

更多预训练模型（如实体识别、机器翻译等）可访问 Hugging Face Mesolitica 获取，详细 API 文档请参阅 Malaya 官方文档。