Welcome to Shmem’s Documentation!

Getting Started

• 快速开始
  • 介绍
  • 软件架构
  • 目录结构说明
  • 软件硬件配套说明
  • 快速上手
  • python侧test用例 python接口API列表
  • unique id 初始化方式
  • SHMEM方式
• 相关脚本
  • build.sh
  • install.sh
  • run.sh
  • set_env.sh
  • uninstall.sh
  • release.sh

Using SHMEM

• SHMEM API 样例
  • Init API
  • Mem API
  • RMA API
  • Sync API
• 编译与构建
  • SHMEM编译
  • 配置文件
• SHMEM日志
  • 环境变量介绍
  • 日志阅读
• SHMEM搭配工具算子调测指导
  • msprof
  • mssanitizer
  • profiling

API

• SHMEM DEF
  • Enumerations
  • Typedefs
  • Macros
  • Structs
  • Constants
• HOST API
  • shmem_host_init.h
  • shmem_log.h
  • shmem_host_heap.h
  • shmem_host_rma.h
  • shmem_host_cc.h
  • shmem_host_p2p_sync.h
  • shmem_host_so.h
  • shmem_host_team.h
• DEVICE API
  • shmem_device_amo.h
  • shmem_device_cc.h
  • shmem_device_mo.h
  • shmem_device_p2p_sync.h
  • shmem_device_rma.h
  • shmem_device_so.h
  • shmem_device_team.h
• SHMEM Python API Reference
  • shmem.core API
  • shmem._pyshmem API
• SHMEM Env Vars
  • 初始化相关
  • 日志相关
  • Profiling相关

Example

• 初始化
  • ACLSHMEMX_INIT_WITH_DEFAULT
  • ACLSHMEMX_INIT_WITH_MPI
  • ACLSHMEMX_INIT_WITH_UNIQUEID
• AllGather
  • 核函数实现

Architecture

• SHMEM原理概述
  • SHMEM初始化流程介绍
  • SHMEM通信域（Team）介绍
• 代码组织结构
  • SHMEM组织结构
  • include
  • src
  • examples
  • tests
  • docs
  • scripts

Troubleshooting And FAQs

• SHMEM 使用限制
• SHMEM 常见问题
  • 内存分配相关问题
  • IP/PORT配置相关问题

Security harding and public IP address

• 安全声明
  • 安全加固
  • 运行用户建议
  • 文件权限控制
  • 构建安全声明
  • 运行安全声明
  • 内存地址随机化机制安全加固
  • 公网地址声明
  • 漏洞机制说明
  • 附录

Indices and tables

• Index

• Module Index

• Search Page