modelscope/README.md

English | 中文 |

Introduction

ModelScope is a “Model-as-a-Service” (MaaS) platform that seeks to bring together most advanced machine learning models from the AI community, and to streamline the process of leveraging AI models in real applications. The core ModelScope library enables developers to perform inference, training and evaluation, through rich layers of API designs that facilitate a unified experience across state-of-the-art models from different AI domains.

The Python library offers the layered-APIs necessary for model contributors to integrate models from CV, NLP, Speech, Multi-Modality, as well as Scientific-computation, into the ModelScope ecosystem. Implementations for all these different models are encapsulated within the library in a way that allows easy and unified access. With such integration, model inference, finetuning, and evaluations can be done with only a few lines of codes. In the meantime, flexibilities are provided so that different components in the model applications can be customized as well, where necessary.

Apart from harboring implementations of various models, ModelScope library also enables the necessary interactions with ModelScope backend services, particularly with the Model-Hub and Dataset-Hub. Such interactions facilitate management of various entities (models and datasets) to be performed seamlessly under-the-hood, including entity lookup, version control, cache management, and many others.

Models and Online Demos

ModelScope has open-sourced more than 600 models, covering NLP, CV, Audio, Multi-modality, and AI for Science, etc., and also contains hundreds of SOTA models. Users can enter the modelhub of ModelScope through Zero-threshold online experience, or experience the model in the way of developing a cloud environment.

Here are some examples:

NLP:

• nlp_gpt3_text-generation_2.7B

• ChatYuan-large

• mengzi-t5-base

• nlp_csanmt_translation_en2zh

• nlp_raner_named-entity-recognition_chinese-base-news

• nlp_structbert_word-segmentation_chinese-base

• Erlangshen-RoBERTa-330M-Sentiment

• nlp_convai_text2sql_pretrain_cn

Audio:

• speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch

• speech_sambert-hifigan_tts_zh-cn_16k

• speech_charctc_kws_phone-xiaoyun

• u2pp_conformer-asr-cn-16k-online

• speech_frcrn_ans_cirm_16k

• speech_dfsmn_aec_psm_16k

CV:

• cv_tinynas_object-detection_damoyolo

• cv_unet_person-image-cartoon_compound-models

• cv_convnextTiny_ocr-recognition-general_damo

• cv_resnet18_human-detection

• cv_resnet50_face-detection_retinaface

• cv_unet_image-matting

• cv_F3Net_product-segmentation

• cv_resnest101_general_recognition

Multi-Modal:

• multi-modal_clip-vit-base-patch16_zh

• ofa_pretrain_base_zh

• Taiyi-Stable-Diffusion-1B-Chinese-v0.1

• mplug_visual-question-answering_coco_large_en

AI for Science:

• uni-fold-monomer

• uni-fold-multimer

QuickTour

We provide unified interface for inference using pipeline, finetuning and evaluation using Trainer for different tasks.

For any tasks with any type of input(image, text, audio, video...), you need only 3 lines of code to load model and get the inference result as follows:

>>> from modelscope.pipelines import pipeline
>>> word_segmentation = pipeline('word-segmentation',model='damo/nlp_structbert_word-segmentation_chinese-base')
>>> word_segmentation('今天天气不错，适合出去游玩')
{'output': '今天 天气 不错 ， 适合 出去 游玩'}

Given an image, you can use following code to cut out the human.

>>> import cv2
>>> from modelscope.pipelines import pipeline

>>> portrait_matting = pipeline('portrait-matting')
>>> result = portrait_matting('https://modelscope.oss-cn-beijing.aliyuncs.com/test/images/image_matting.png')
>>> cv2.imwrite('result.png', result['output_img'])

The output image is

For finetuning and evaluation, you need ten more lines of code to construct dataset and trainer, and by calling traner.train() and trainer.evaluate() you can finish finetuning and evaluating a certain model.

>>> from modelscope.metainfo import Trainers
>>> from modelscope.msdatasets import MsDataset
>>> from modelscope.trainers import build_trainer

>>> train_dataset = MsDataset.load('chinese-poetry-collection', split='train'). remap_columns({'text1': 'src_txt'})
>>> eval_dataset = MsDataset.load('chinese-poetry-collection', split='test').remap_columns({'text1': 'src_txt'})
>>> max_epochs = 10
>>> tmp_dir = './gpt3_poetry'

>>> kwargs = dict(
     model='damo/nlp_gpt3_text-generation_1.3B',
     train_dataset=train_dataset,
     eval_dataset=eval_dataset,
     max_epochs=max_epochs,
     work_dir=tmp_dir)

>>> trainer = build_trainer(name=Trainers.gpt3_trainer, default_args=kwargs)
>>> trainer.train()

Why should I use ModelScope library

1. A unified and concise user interface is abstracted for different tasks and different models. Three lines of code complete the inference, and 10 lines of code complete the model training. It is convenient for users to use different models in multiple fields in the ModelScope community. It is ready to use and easy to get started with AI. and teaching.

2. Construct a model-centric development and application experience, support model training, inference, export and deployment, and facilitate users to build their own MLOps based on the ModelScope Library.

3. For the model inference and training process, a modular design is carried out, and a wealth of functional module implementations are provided, which is convenient for users to customize development to customize their own model inference, training and other processes.

4. For distributed model training, especially for large models, it provides rich training strategy support, including data parallel, model parallel, hybrid parallel and so on.

Installation

Docker

ModelScope Library currently supports tensorflow and pytorch deep learning framework for model training and inference, and it is tested and run on Python 3.7+, Pytorch 1.8+, Tensorflow1.15 or Tensorflow2.0+.

In order to allow everyone to directly use all the models on the ModelScope platform without configuring the environment, ModelScope provides official docker image for developers who need it. Based on the official image, you can skip all environment installation and configuration and use it directly. Currently, the latest version of the CPU image and GPU image we provide can be obtained from the following address

CPU docker image

registry.cn-hangzhou.aliyuncs.com/modelscope-repo/modelscope:ubuntu20.04-py37-torch1.11.0-tf1.15.5-1.3.0

GPU docker image

registry.cn-hangzhou.aliyuncs.com/modelscope-repo/modelscope:ubuntu20.04-cuda11.3.0-py37-torch1.11.0-tf1.15.5-1.3.0

Setup Local Python Environment

Also you can setup your local python environment using pip and conda. We suggest to use anaconda to create your python environment:

conda create -n modelscope python=3.7
conda activate modelscope

Then you can install pytorch or tensorflow according to your model requirements.

• Install pytorch doc
• Install tensorflow doc

After installing the necessary framework, you can install modelscope library as follows:

If you only want to download models and datasets, install modelscope framework

pip install modelscope

If you want to use multi-modal models:

pip install modelscope[multi-modal]

If you want to use nlp models:

pip install modelscope[nlp] -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html

If you want to use cv models:

pip install modelscope[cv] -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html

If you want to use audio models:

pip install modelscope[audio] -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html

If you want to use science models:

pip install modelscope[science] -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html

Notes:

1. Currently, some audio-task models only support python3.7, tensorflow1.15.4 Linux environments. Most other models can be installed and used on windows and Mac (x86).

2. Some models in the audio field use the third-party library SoundFile for wav file processing. On the Linux system, users need to manually install libsndfile of SoundFile(doc link). On Windows and MacOS, it will be installed automatically without user operation. For example, on Ubuntu, you can use following commands:

   sudo apt-get update
   sudo apt-get install libsndfile1
   

3. Some models in computer vision need mmcv-full, you can refer to mmcv installation guide, a minimal installation is as follows:

   pip uninstall mmcv # if you have installed mmcv, uninstall it
   pip install -U openmim
   mim install mmcv-full
   

Learn More

We provide additional documentations including:

• More detailed Installation Guide
• Introduction to tasks
• Use pipeline for model inference
• Finetuning example
• Preprocessing of data
• Evaluation
• Contribute your own model to ModelScope

License

This project is licensed under the Apache License (Version 2.0).