OSS使用

在DLC中挂载OSS

在创建分布式训练（DLC）任务时，挂载OSS数据。支持以下几种挂载类型，具体配置方法，请参见创建训练任务。

使用该方式挂载OSS，默认配置有如下限制，并不适合所有的场景：

• 为了快速读取OSS文件，挂载OSS时会有元数据（目录与文件列表）的缓存。

  在分布式任务中，如果有多个节点需要创建同一个目录并检查目录是否存在，元数据的Cache会导致每个节点都尝试进行创建。实际只有一个节点能成功创建目录，其它节点会报错。

• 默认使用OSS的MultiPart API来创建文件，在写文件的过程中，在OSS上看不到该对象。当所有写操作完成后，才能在OSS页面上查看。

• 不支持同时进行文件的写入和读取操作。

• 不支持对文件进行随机写入操作。

您可以参照以下操作步骤，通过调整底层参数来适配具体的场景。

1. 完成以下准备工作。

   1. 安装工作空间的SDK。

      !pip install alibabacloud-aiworkspace20210204

   2. 配置环境变量。具体操作，请参见安装Credentials工具和在Linux、macOS和Windows系统配置环境变量。

2. 调整底层参数，适配以下场景。

   如何选择不同的JindoFuse版本

   示例代码如下：

   import json
   from alibabacloud_tea_openapi.models import Config
   from alibabacloud_credentials.client import Client as CredClient
   from alibabacloud_aiworkspace20210204.client import Client as AIWorkspaceClient
   from alibabacloud_aiworkspace20210204.models import UpdateDatasetRequest
   
   
   def change_version():
       # 使用DLC任务所在地域。例如华东1（杭州）配置为cn-hangzhou。
       region_id = 'cn-hangzhou'
       # 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
       # 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
       # 本示例通过Credentials SDK默认从环境变量中读取AccessKey，来实现身份验证。您需要先安装Credentials工具和配置环境变量。
       cred = CredClient()
       dataset_id = '** 数据集的ID **'
   
       workspace_client = AIWorkspaceClient(
           config=Config(
               credential=cred,
               region_id=region_id,
               endpoint="aiworkspace.{}.aliyuncs.com".format(region_id),
           )
       )
       # 1、get the content of dataset
       get_dataset_resp = workspace_client.get_dataset(dataset_id)
       options = json.loads(get_dataset_resp.body.options)
       # 配置jindo-fuse的版本，可以配置为6.4.4， 6.7.0，6.6.0，release note详见：https://aliyun.github.io/alibabacloud-jindodata/releases/
       options['fs.jindo.fuse.pod.image.tag'] = "6.7.0"
   
       update_request = UpdateDatasetRequest(
           options=json.dumps(options)
       )
       # 2、update options
       workspace_client.update_dataset(dataset_id, update_request)
       print('new options is: {}'.format(update_request.options))
   change_version()

   如何关掉元数据Cache

   当执行分布式任务且多个节点同时尝试向同一目录写文件时，Cache可能会引起部分节点的写入操作失败。您可以通过修改fuse的命令行参数，增加-oattr_timeout=0-oentry_timeout=0-onegative_timeout=0来解决该问题。示例代码如下。

   import json
   from alibabacloud_tea_openapi.models import Config
   from alibabacloud_credentials.client import Client as CredClient
   from alibabacloud_aiworkspace20210204.client import Client as AIWorkspaceClient
   from alibabacloud_aiworkspace20210204.models import UpdateDatasetRequest
   
   
   def turnOffMetaCache():
       region_id = 'cn-hangzhou'
       # 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
       # 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
       # 本示例通过Credentials SDK默认从环境变量中读取AccessKey，来实现身份验证。您需要先安装Credentials工具和配置环境变量。
       cred = CredClient()
       dataset_id = '** 数据集的ID **'
       workspace_client = AIWorkspaceClient(
         config=Config(
               credential=cred,
               region_id=region_id,
               endpoint="aiworkspace.{}.aliyuncs.com".format(region_id),
         )
       )
       # 1、get the content of dataset
       get_dataset_resp = workspace_client.get_dataset(dataset_id)
       options = json.loads(get_dataset_resp.body.options)
   
       options['fs.jindo.args'] = '-oattr_timeout=0 -oentry_timeout=0 -onegative_timeout=0'
   
       update_request = UpdateDatasetRequest(
           options=json.dumps(options)
       )
       # 2、update options
       workspace_client.update_dataset(dataset_id, update_request)
       print('new options is: {}'.format(update_request.options))
   
   
   turnOffMetaCache()
   

   如何调整上传（下载）数据的线程数目

   通过配置以下参数来调整线程数据：

   • fs.oss.upload.thread.concurrency:32

   • fs.oss.download.thread.concurrency:32

   • fs.oss.read.readahead.buffer.count:64

   • fs.oss.read.readahead.buffer.size:4194304

   示例代码如下：

   import json
   from alibabacloud_tea_openapi.models import Config
   from alibabacloud_credentials.client import Client as CredClient
   from alibabacloud_aiworkspace20210204.client import Client as AIWorkspaceClient
   from alibabacloud_aiworkspace20210204.models import UpdateDatasetRequest
   
   
   def adjustThreadNum():
       # 使用DLC任务所在地域。例如华东1（杭州）配置为cn-hangzhou。
       region_id = 'cn-hangzhou'
       # 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
       # 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
       # 本示例通过Credentials SDK默认从环境变量中读取AccessKey，来实现身份验证。您需要先安装Credentials工具和配置环境变量。
       cred = CredClient()
       dataset_id = '** 数据集的ID **'
   
       workspace_client = AIWorkspaceClient(
           config=Config(
               credential=cred,
               region_id=region_id,
               endpoint="aiworkspace.{}.aliyuncs.com".format(region_id),
           )
       )
       # 1、get the content of dataset
       get_dataset_resp = workspace_client.get_dataset(dataset_id)
       options = json.loads(get_dataset_resp.body.options)
   
       options['fs.oss.upload.thread.concurrency'] = 32
       options['fs.oss.download.thread.concurrency'] = 32
       options['fs.oss.read.readahead.buffer.count'] = 32
    
       update_request = UpdateDatasetRequest(
           options=json.dumps(options)
       )
       # 2、update options
       workspace_client.update_dataset(dataset_id, update_request)
       print('new options is: {}'.format(update_request.options))
    
    
   adjustThreadNum()
   

   如何使用AppendObject方式挂载OSS文件

   所有在本地OSS创建的文件，都会调用OSS的AppendObject接口来创建Object（文件）。通过AppendObject方式最后生成的Object大小不得超过5 GB，关于AppendObject的更多使用限制，请参见AppendObject。示例代码如下：

   import json
   from alibabacloud_tea_openapi.models import Config
   from alibabacloud_credentials.client import Client as CredClient
   from alibabacloud_aiworkspace20210204.client import Client as AIWorkspaceClient
   from alibabacloud_aiworkspace20210204.models import UpdateDatasetRequest
   
   
   def useAppendObject():
       # 使用DLC任务所在地域。例如华东1（杭州）配置为cn-hangzhou。
       region_id = 'cn-hangzhou'
       # 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
       # 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
       # 本示例通过Credentials SDK默认从环境变量中读取AccessKey，来实现身份验证。您需要先安装Credentials工具和配置环境变量。
       cred = CredClient()
       dataset_id = '** 数据集的ID **'
   
       workspace_client = AIWorkspaceClient(
           config=Config(
               credential=cred,
               region_id=region_id,
               endpoint="aiworkspace.{}.aliyuncs.com".format(region_id),
           )
       )
       # 1、get the content of dataset
       get_dataset_resp = workspace_client.get_dataset(dataset_id)
       options = json.loads(get_dataset_resp.body.options)
   
       options['fs.jindo.args'] = '-oattr_timeout=0 -oentry_timeout=0 -onegative_timeout=0'
       options['fs.oss.append.enable'] = "true"
       options['fs.oss.flush.interval.millisecond'] = "1000"
       options['fs.oss.read.buffer.size'] = "262144"
       options['fs.oss.write.buffer.size'] = "262144"
   
       update_request = UpdateDatasetRequest(
           options=json.dumps(options)
       )
       # 2、update options
       workspace_client.update_dataset(dataset_id, update_request)
       print('new options is: {}'.format(update_request.options))
   
   
   useAppendObject()

   如何挂载OSS-HDFS

   如何开通OSS-HDFS，请参见什么是OSS-HDFS服务。使用OSS-HDFS的Endpoint来创建数据集的示例代码如下：

   import json
   from alibabacloud_tea_openapi.models import Config
   from alibabacloud_credentials.client import Client as CredClient
   from alibabacloud_aiworkspace20210204.client import Client as AIWorkspaceClient
   from alibabacloud_aiworkspace20210204.models import CreateDatasetRequest
   
   
   def createOssHdfsDataset():
       # 使用DLC任务所在地域。例如华东1（杭州）配置为cn-hangzhou。
       region_id = 'cn-hangzhou'
       # 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
       # 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
       # 本示例通过Credentials SDK默认从环境变量中读取AccessKey，来实现身份验证。您需要先安装Credentials工具和配置环境变量。
       cred = CredClient()
       workspace_id = '** DLC任务所在工作空间ID **'
   
       oss_bucket = '** OSS-Bucket **'
       # 使用OSS-HDFS的Endpoint。
       oss_endpoint = f'{region_id}.oss-dls.aliyuncs.com'
       # 需要挂载的OSS-HDFS路径。
       oss_path = '/'
       # 本地挂载路径。
       mount_path = '/mnt/data/'
   
       workspace_client = AIWorkspaceClient(
           config=Config(
               credential=cred,
               region_id=region_id,
               endpoint="aiworkspace.{}.aliyuncs.com".format(region_id),
           )
       )
   
       response = workspace_client.create_dataset(CreateDatasetRequest(
           workspace_id=workspace_id,
           name="** 数据集的名字 **",
           data_type='COMMON',
           data_source_type='OSS',
           property='DIRECTORY',
           uri=f'oss://{oss_bucket}.{oss_endpoint}{oss_path}',
           accessibility='PRIVATE',
           source_type='USER',
           options=json.dumps({
               'mountPath': mount_path,
               # 在分布式训练的场景下建议增加以下参数。
               'fs.jindo.args': '-oattr_timeout=0 -oentry_timeout=0 -onegative_timeout=0 -ono_symlink -ono_xattr -ono_flock -odirect_io',
               'fs.oss.flush.interval.millisecond': "10000",
               'fs.oss.randomwrite.sync.interval.millisecond': "10000",
           })
       ))
       print(f'datasetId: {response.body.dataset_id}')
   
   createOssHdfsDataset()
   
   

   如何配置内存资源

   通过配置fs.jindo.fuse.pod.mem.limit参数来调整内存资源，示例代码如下：

   import json
   from alibabacloud_tea_openapi.models import Config
   from alibabacloud_credentials.client import Client as CredClient
   from alibabacloud_aiworkspace20210204.client import Client as AIWorkspaceClient
   from alibabacloud_aiworkspace20210204.models import UpdateDatasetRequest
   
   
   def adjustResource():
       # 使用DLC任务所在地域。例如华东1（杭州）配置为cn-hangzhou。
       region_id = 'cn-hangzhou'
       # 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
       # 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
       # 本示例通过Credentials SDK默认从环境变量中读取AccessKey，来实现身份验证。您需要先安装Credentials工具和配置环境变量。
       cred = CredClient()
       dataset_id = '** 数据集的ID **'
   
       workspace_client = AIWorkspaceClient(
           config=Config(
               credential=cred,
               region_id=region_id,
               endpoint="aiworkspace.{}.aliyuncs.com".format(region_id),
           )
       )
       # 1、get the content of dataset
       get_dataset_resp = workspace_client.get_dataset(dataset_id)
       options = json.loads(get_dataset_resp.body.options)
       # 需要配置的内存资源。
       options['fs.jindo.fuse.pod.mem.limit'] = "10Gi"
   
       update_request = UpdateDatasetRequest(
           options=json.dumps(options)
       )
       # 2、update options
       workspace_client.update_dataset(dataset_id, update_request)
       print('new options is: {}'.format(update_request.options))
   
   
   adjustResource()
   

在DSW中挂载OSS

在创建DSW实例时，挂载OSS数据。支持以下几种挂载类型，具体配置方法，请参见创建DSW实例。

本文提供部分场景的Jindo配置建议，并未覆盖所有场景下的最优性能。更灵活的配置，请参见JindoFuse使用指南。

• 快速读写：允许用户读写，读取速度快，但并发读写可能会出现数据不一致的问题，适合挂载训练数据和模型，不适合作为工作目录。

  {
    "fs.oss.download.thread.concurrency": "cpu核数2倍",
    "fs.oss.upload.thread.concurrency": "cpu核数2倍",
    "fs.jindo.args": "-oattr_timeout=3 -oentry_timeout=0 -onegative_timeout=0 -oauto_cache -ono_symlink"
  }
  

• 增量读写：在增量写入时能够保证数据一致性，覆盖原有数据会有一致性问题。读取速度略慢，适合保存训练的模型权重文件。

  {
    "fs.oss.upload.thread.concurrency": "cpu核数2倍",
    "fs.jindo.args": "-oattr_timeout=3 -oentry_timeout=0 -onegative_timeout=0 -oauto_cache -ono_symlink"
  }
  

• 读写一致：在并发读写中能保持数据一致性，适用于对数据一致性要求高，可以容忍读取速度慢的场景，适合保存代码项目。

  {
    "fs.jindo.args": "-oattr_timeout=0 -oentry_timeout=0 -onegative_timeout=0 -oauto_cache -ono_symlink"
  }
  

• 只读：仅允许读取，不允许写入，适合挂载公共数据集。

  {
    "fs.oss.download.thread.concurrency": "cpu核数2倍",
    "fs.jindo.args": "-oro -oattr_timeout=7200 -oentry_timeout=7200 -onegative_timeout=7200 -okernel_cache -ono_symlink"
  }

使用限制

• 官方镜像：仅在分布式训练（DLC）任务或DSW实例中选择Pytorch 2.0及其以上版本的镜像时，才能使用OSS Pytorch Connector模块。

• 自定义镜像：仅支持Pytorch 2.0及其以上版本，对于满足版本要求的镜像，您可以通过下述指令安装OSS Pytorch Connector模块。

  pip install -i http://yum.tbsite.net/aliyun-pypi/simple/ --extra-index-url http://yum.tbsite.net/pypi/simple/ --trusted-host=yum.tbsite.net osstorchconnector

• Python版本：仅支持Python 3.8~3.12版本。

准备工作

1. 配置credential文件。

   您可以使用以下任意一种方式配置credential：

   • 您可以参考配置DLC RAM角色，为分布式训练（DLC）任务配置免密访问OSS的credential。通过这种方式，DLC任务将获取STS临时访问凭证，能够安全地访问OSS或其他云资源，无需显式配置认证信息，从而降低密钥泄露的风险。

   • 在代码项目中配置credential文件，管理认证信息。配置示例如下：

     说明

     明文配置AK信息存在安全风险，建议您使用角色配置在DLC实例内自动配置credential，详情请参见配置DLC RAM角色。

     在使用OSS Pytorch Connector接口时，您可以通过指定credential文件的路径，自动获取认证信息，以便进行OSS数据请求的认证。

     {
       "AccessKeyId": "<Access-key-id>",
       "AccessKeySecret": "<Access-key-secret>",
       "SecurityToken": "<Security-Token>",
       "Expiration": "2024-08-20T00:00:00Z"
     }

     具体配置项说明如下：

     配置项	是否必填	说明	示例值
     AccessKeyId	是	阿里云账号或者RAM用户的AccessKey ID和AccessKey Secret。 说明 当使用从STS获取的临时访问凭证访问OSS时，请设置为临时访问凭证的AccessKey ID和AccessKey Secret。	NTS****
     AccessKeySecret	是		7NR2****
     SecurityToken	否	临时访问令牌。当使用从STS获取的临时访问凭证访问OSS时，需要设置此参数。	STS.6MC2****
     Expiration	否	鉴权信息过期时间，Expiration为空表示永不过期，鉴权时间过期后OSS Connector会重新读取鉴权信息。	2024-08-20T00:00:00Z

2. 配置config.json文件，内容示例如下：

   在代码项目中配置config.json文件，管理诸如并发处理数量、预取参数以及其他核心参数，同时定义日志文件的存储位置等重要信息。使用OSS Pytorch Connector接口时，通过指定config.json文件的路径，系统可以自动获取到读取时并发处理量、预取值，并将请求OSS数据的相关日志输出到指定的日志文件中。

   {
       "logLevel": 1,
       "logPath": "/var/log/oss-connector/connector.log",
       "auditPath": "/var/log/oss-connector/audit.log",
       "datasetConfig": {
           "prefetchConcurrency": 24,
           "prefetchWorker": 2
       },
       "checkpointConfig": {
           "prefetchConcurrency": 24,
           "prefetchWorker": 4,
           "uploadConcurrency": 64
       }
   }

   具体配置项说明如下：

   配置项		是否必填	说明	示例值
   logLevel		是	日志记录级别。默认为INFO级别。取值如下： 0：表示Debug。 1：表示INFO。 2：表示WARN。 3：表示ERROR。	1
   logPath		是	connector日志路径。默认路径为/var/log/oss-connector/connector.log。	/var/log/oss-connector/connector.log
   auditPath		是	connector IO的审计日志，记录延迟大于100毫秒的读写请求。默认路径为/var/log/oss-connector/audit.log。	/var/log/oss-connector/audit.log
   DatasetConfig	prefetchConcurrency	是	使用Dataset从OSS预取数据时的并发数，默认为24。	24
   	prefetchWorker	是	使用Dataset从OSS预取可使用vCPU数，默认为4。	2
   checkpointConfig	prefetchConcurrency	是	使用checkpoint read从OSS预取数据时的并发数，默认为24。	24
   	prefetchWorker	是	使用checkpoint read从OSS预取可使用vCPU数，默认为4。	4
   	uploadConcurrency	是	使用checkpoint write上传数据时的并发数，默认为64。	64

使用方式

OSS Pytorch Connector提供了OssMapDataset和OssIterableDataset两种数据集访问接口，分别是对Dataset和IterableDataset接口的扩展。OssIterableDataset进行了预取优化，因此训练效率相对较高。OssMapDataset的数据读取顺序由DataLoader决定，支持shuffle操作。因此，您可以参考以下建议选择数据集访问接口：

• 如果内存较小或数据量较大，只需要顺序读取且对并行处理的要求不高，建议您使用OssIterableDataset来构建Dataset。

• 相反，如果内存充足、数据量较小，并且需要随机操作和并行处理，建议您使用OssMapDataset来构建Dataset。

同时，OSS Pytorch Connector也提供了OssCheckpoint接口以支持模型加载和保存。当前，OssCheckpoint功能仅限于在通用资源环境下使用。

以下内容为您介绍这三种接口的使用方式：

checkpoint = OssCheckpoint(endpoint="{oss_endpoint}", cred_path=cred_path, config_path=config_path)

checkpoint_read_uri = "{checkpoint_path}"
checkpoint_write_uri = "{checkpoint_path}"
with checkpoint.reader(checkpoint_read_uri) as reader:
    state_dict = torch.load(reader)
    model.load_state_dict(state_dict)
with checkpoint.writer(checkpoint_write_uri) as writer:
    torch.save(model.state_dict(), writer)

代码示例

以下是OSS Pytorch Connector的示例代码，您可以使用该示例代码访问OSS数据：

from osstorchconnector import OssMapDataset, OssCheckpoint
import torchvision.transforms as transforms
import accimage
import torchvision.models as models
import torch

cred_path = "/mnt/.alibabacloud/credentials"  # 为DLC任务和DSW实例配置角色信息之后credential的默认路径。
config_path = "config.json"
checkpoint = OssCheckpoint(endpoint="{oss_endpoint}", cred_path=cred_path, config_path=config_path)
model = models.__dict__["resnet18"]()

epochs = 100  # 指定epoch
checkpoint_read_uri = "{checkpoint_path}"
checkpoint_write_uri = "{checkpoint_path}"
with checkpoint.reader(checkpoint_read_uri) as reader:
    state_dict = torch.load(reader)
    model.load_state_dict(state_dict)


def read_and_transform(data):
    normalize = transforms.Normalize(mean=[0.485, 0.456, 0.406],
                                     std=[0.229, 0.224, 0.225])
    transform = transforms.Compose([
        transforms.RandomResizedCrop(224),
        transforms.RandomHorizontalFlip(),
        transforms.ToTensor(),
        normalize,
    ])

    try:
        img = accimage.Image((data.read()))
        value = transform(img)
    except Exception as e:
        print("read failed", e)
        return None, 0
    return value, 0
dataset = OssMapDataset.from_prefix("{oss_data_folder_uri}", endpoint="{oss_endpoint}", transform=read_and_transform, cred_path=cred_path, config_path=config_path)
data_loader = torch.utils.data.DataLoader(
    dataset, batch_size="{batch_size}",num_workers="{num_workers"}, pin_memory=True)

for epoch in range(args.epochs):
    for step, (images, target) in enumerate(data_loader):
        # batch processing
        # model training
    # save model
    with checkpoint.writer(checkpoint_write_uri) as writer:
        torch.save(model.state_dict(), writer)

上述代码的关键实现说明如下：

• 使用OssMapDataset直接基于给定的OSS URI，构建一个与Pytorch Dataloader使用范式一致的dataset。

• 使用该dataset，构建Torch的标准Dataloader，并通过loop dataloader进行标准的训练流程，如对当前batch的处理、模型训练与保存等。

• 同时，这一过程无需将数据集挂载到容器环境中，也无需事先将数据存储至本地，实现了数据的按需加载。

OSS Python SDK

您可以直接使用OSS Python SDK读写OSS中的数据，具体操作步骤如下：

1. 安装OSS Python SDK。详情请参见安装。

2. 为OSS Python SDK配置访问凭证，详情请参见配置访问凭证。

3. 读写OSS数据。

   # -*- coding: utf-8 -*-
   import oss2
   from oss2.credentials import EnvironmentVariableCredentialsProvider
   
   # 使用环境变量中获取的RAM用户访问密钥配置访问凭证
   auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
   bucket = oss2.Bucket(auth, '<Endpoint>', '<your_bucket_name>')
   # 读取一个完整文件。
   result = bucket.get_object('<your_file_path/your_file>')
   print(result.read())
   # 按Range读取数据。
   result = bucket.get_object('<your_file_path/your_file>', byte_range=(0, 99))
   # 写数据至OSS。
   bucket.put_object('<your_file_path/your_file>', '<your_object_content>')
   # 对Appendable类型文件进行Append。
   result = bucket.append_object('<your_file_path/your_file>', 0, '<your_object_content>')
   result = bucket.append_object('<your_file_path/your_file>', result.next_position, '<your_object_content>')
   

   您需要根据实际需要修改以下配置项：

   配置项	描述
   <Endpoint>	填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。关于获取Endpoint的更多信息，请参见OSS地域和访问域名。
   <your_bucket_name>	填写存储空间名称。
   <your_file_path/your_file>	表示待读写的文件路径。填写不包含Bucket名称在内的Object完整路径，例如testfolder/exampleobject.txt。
   <your_object_content>	表示待Append的内容，需要根据实际情况修改。

OSS Python API

使用OSS Python API，您可以方便地在OSS中存储训练数据和模型。在开始操作之前，请确保已安装OSS Python SDK，并正确设置访问凭据，详情请参见安装和配置访问凭证。

• 加载训练数据

  您可以将数据存放在一个OSS Bucket中，且将数据路径和对应的Label存储在同一个OSS Bucket的索引文件中。通过自定义DataSet，在PyTorch中使用DataLoaderAPI多进程并行读取数据，示例如下。

  import io
  import oss2
  from oss2.credentials import EnvironmentVariableCredentialsProvider
  import PIL
  import torch
  
  class OSSDataset(torch.utils.data.dataset.Dataset):
      def __init__(self, endpoint, bucket, auth, index_file):
          self._bucket = oss2.Bucket(auth, endpoint, bucket)
          self._indices = self._bucket.get_object(index_file).read().split(',')
  
      def __len__(self):
          return len(self._indices)
  
      def __getitem__(self, index):
          img_path, label = self._indices(index).strip().split(':')
          img_str = self._bucket.get_object(img_path)
          img_buf = io.BytesIO()
          img_buf.write(img_str.read())
          img_buf.seek(0)
          img = Image.open(img_buf).convert('RGB')
          img_buf.close()
          return img, label
  
  
  # 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
  auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
  dataset = OSSDataset(endpoint, bucket, auth, index_file)
  data_loader = torch.utils.data.DataLoader(
      dataset,
      batch_size=batch_size,
      num_workers=num_loaders,
      pin_memory=True)
  

  其中关键配置说明如下：

  关键配置	描述
  endpoint	填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。关于获取Endpoint的更多信息，请参见OSS地域和访问域名。
  bucket	填写存储空间名称。
  index_file	索引文件的路径。 说明 示例中，索引文件格式为每条样本使用英文逗号（,）分隔，样本路径与Label之间使用英文冒号（:）分隔。

• Save或Load模型

  您可以使用OSS Python API Save或Load PyTorch模型（关于PyTorch如何Save或Load模型，详情请参见PyTorch），示例如下：

  • Save模型

    from io import BytesIO
    import torch
    import oss2
    from oss2.credentials import EnvironmentVariableCredentialsProvider
    
    auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
    # bucket_name
    bucket_name = "<your_bucket_name>"
    bucket = oss2.Bucket(auth, endpoint, bucket_name)
    buffer = BytesIO()
    torch.save(model.state_dict(), buffer)
    bucket.put_object("<your_model_path>", buffer.getvalue())
    

    其中

    • endpoint为Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。

    • <your_bucket_name>为OSS Bucket名称，且开头不带oss://。

    • <your_model_path>为模型路径，都需要根据实际情况修改。

  • Load模型

    from io import BytesIO
    import torch
    import oss2
    from oss2.credentials import EnvironmentVariableCredentialsProvider
    
    auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
    bucket_name = "<your_bucket_name>"
    bucket = oss2.Bucket(auth, endpoint, bucket_name)
    buffer = BytesIO(bucket.get_object("<your_model_path>").read())
    model.load_state_dict(torch.load(buffer))

    其中

    • endpoint为Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。

    • <your_bucket_name>为OSS Bucket名称，且开头不带oss://。

    • <your_model_path>为模型路径，都需要根据实际情况修改。