Data

Tools

Indexes

Applications

Experiments

Open Source Science

openfold-for-fugaku

https://github.com/riken-rccs/openfold-for-fugaku

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: RIKEN-RCCS
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 8.19 MB
Statistics
  • Stars: 4
  • Watchers: 16
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 3 years ago · Last pushed about 2 years ago
Metadata Files
Readme License Citation

README.md

「富岳」実装版OpenFold (OpenFold for Fugaku)

ソースコードと必要ファイルの取得

「富岳」実装版OpenFoldのソースコードをクローンする shell git clone https://github.com/RIKEN-RCCS/OpenFold-for-Fugaku.git cd OpenFold-for-Fugaku

openfold/resources/ディレクトリにstereo_chemical_props.txtをダウンロードする shell wget -P openfold/resources https://git.scicore.unibas.ch/schwede/openstructure/-/raw/7102c63615b64735c4941278d92b554ec94415f8/modules/mol/alg/src/stereo_chemical_props.txt

データセットの取得

データセットを保存する任意のディレクトリ(以降DATADIRと記載)を用意しておく。 aria2をインストールしたのち、学習済みモデルおよび推論や学習に必要なデータセットをダウンロードする。

``shell git clone https://github.com/spack/spack.git SPACK_ROOT=pwd`/spack source $SPACK_ROOT/share/spack/setup-env.sh spack install aria2 spack load aria2

DATADIR="データセットを保存するディレクトリ" bash scripts/downloadalphafoldparams.sh $DATADIR bash scripts/downloadalphafolddbs.sh $DATADIR reduced_dbs ```

初期設定

scripts/setenvの以下の環境変数を設定する

  • PREFIX: インストールディレクトリ (必須)
  • OPENFOLDDIR: このREADME.mdがあるディレクトリ (必須)
  • DATADIR: データセットをダウンロードしたディレクトリ (必須)
  • PJSUB_OPT: ジョブ投入時の追加オプション (任意)
    • シングルアカウントの場合は-g <グループID>を指定する
    • 必要におうじて-x PJM_LLIO_GFSCACHE=<ボリューム>を指定する

インストール

インストールジョブを投入するスクリプトを実行する ./scripts/install_fugaku.sh ジョブの出力はinstall_openfold.*_0.outとinstall_openfold.*_1.outに書き込まれます。ジョブの終了後、それらのファイルの最後にFinishedが出力されていることを確認してください。

推論

対象配列が少数である場合

inferenceディレクトリのシングルノード版スクリプトで前処理と推論を連続して行います。詳細はこちら

対象配列が多数である場合

  1. preproc_fugakuディレクトリのマルチノード版スクリプトで前処理を行います。詳細はこちら
  2. inferenceディレクトリのスクリプトで推論を行います。詳細はこちら

Copyright notice

Copyright 2023 RIKEN & Fujitsu Limited

This software includes AlphaFold and OpenFold that are distributed in the Apache License 2.0. However, DeepMind's pretrained parameters fall under the CC BY 4.0 license, a copy of which is downloaded to openfold/resources/params by the installation script. Note that the latter replaces the original, more restrictive CC BY-NC 4.0 license as of January 2022.

Changes from the original OpenFold

  • Add code to preprocess multiple sequences using multiple nodes in Fugaku
  • Add code to infer multiple sequences using multiple nodes in Fugaku
  • Port the memory-efficient attention module to CPUs
  • Improve processing efficiency of batch matrix multiplications (BMMs) by making the input tensors to BMMs contiguous
  • Speed up reading of mmcif data by pickling and lz4 compression beforehand

Owner

  • Name: RIKEN R-CCS
  • Login: RIKEN-RCCS
  • Kind: organization
  • Email: github-riken-rccs@ml.riken.jp
  • Location: Kobe, Japan

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "For now, cite OpenFold with its DOI."
authors:
- family-names: "Ahdritz"
  given-names: "Gustaf"
  orcid: https://orcid.org/0000-0001-8283-5324
- family-names: "Bouatta"
  given-names: "Nazim"
  orcid: https://orcid.org/0000-0002-6524-874X
- family-names: "Kadyan"
  given-names: "Sachin"
- family-names: "Xia"
  given-names: "Qinghui"
- family-names: "Gerecke"
  given-names: "William"
- family-names: "AlQuraishi"
  given-names: "Mohammed"
  orcid: https://orcid.org/0000-0001-6817-1322
title: "OpenFold"
doi: 10.5281/zenodo.5709539
date-released: 2021-11-12
url: "https://github.com/aqlaboratory/openfold"

GitHub Events

Total
Last Year

Dependencies

environment.yml pypi
  • PyYAML ==5.4.1
  • biopython ==1.79
  • deepspeed ==0.5.9
  • dm-tree ==0.1.6
  • ml-collections ==0.1.0
  • numpy ==1.21.2
  • pytorch_lightning ==1.5.10
  • requests ==2.26.0
  • scipy ==1.7.1
  • tqdm ==4.62.2
  • typing-extensions ==3.10.0.2
Dockerfile docker
  • nvidia/cuda 10.2-cudnn8-runtime-ubuntu18.04 build
scripts/install_fugaku_requirements.txt pypi
  • biopython ==1.79
  • dm-tree ==0.1.6
  • lz4 *
  • ml-collections ==0.1.0
  • protobuf *
  • pytorch_lightning ==1.5.0
  • tqdm ==4.62.2
setup.py pypi
  • biopython *
  • deepspeed *
  • dm-tree *
  • ml-collections *
  • numpy *
  • pytorch_lightning *
  • scipy *
  • torch *