[{"_1":2,"_186":-5,"_187":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_161":162},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_85":86,"_107":108,"_152":-5,"_153":11,"_154":17,"_155":11,"_156":-5,"_157":11,"_158":-5,"_159":160},"canonicalUrl","https://hub.docker.com/r/foldingathome/fah-gpu-amd/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","foldingathome","reponame","fah-gpu-amd","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":58,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":69,"_70":71,"_76":11,"_77":78,"_82":29,"_83":84},"categories",[],"content_types",[40],"image","date_registered","2022-02-02T14:10:53.864831Z","description","Official Folding@home AMD GPU Container","is_private","last_updated","2022-02-15T04:42:54.015182Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",3500,"repository_type","star_count",1,"status","status_description","active","source","collaborator_count",0,"full_description","# fah-rocm - Folding@home GPU Container for AMD ROCm stack\n\nThis file covers only information specific to the `fah-gpu-amd` container.\nRead the README and CONTRIBUTING at\n for design goals,\narchitecture, guidelines for contributing, and other information.\n\nFamiliarity with Linux and containers is assumed. Due to the prerequisites\nand setup complexity this does not make an ideal \"hello-world\" container -\nthe standard Folding@home Linux clients work great and have _slightly_ less\noverhead.\n\n## Overview\n\n_The Foldin Rule: If the client gets a Work Unit, finish the Work Unit._\n\nRunning the Folding@home container is straightforward, however special care\nmust be taken to manage and return Work Units on time.\n\nThe Folding@home container is similar to a database container needing\npersistent storage mounted into /fah and careful lifecycle management to\navoid losing or wasting work. The config.xml also contains client state.\n\n### Operating Containers\n\nEach of these is explained in more detail below, but they are included here\nfor clarity. RFC 2119 meanings.\n\n* MUST mount read-writable persistent storage to `/fah` of the running\n container. Running containers MUST NOT share the same mounted directory,\n but directories SHOULD be reused to avoid lost Work Units.\n* MUST create and preload a tuned `config.xml` in each persistent\n storage directory before running the container for the first time.\n* MUST run the container as a uid:gid, specified with with `--user` or\n equivalent, so that the running container has read-write permissions to\n the persistent storage mounted in `/fah`.\n* MUST run the container as a user who is a member of the 'video' group and,\n if present, the 'render' group.\n* SHOULD NOT run containers as root.\n* SHOULD NOT expose ports to internet without firewall rules, encryption, and\n strong passwords.\n\n## Folding@home Websites\n\n* Folding@home: \n* Folding@home Support Forum: \n* Folding@home Containers GitHub: \n* Folding@home Docker Hub: \n\n## Feedback and Issues\n\nPlease raise any bugs or issues with the containers on GitHub:\n\n\n## Prerequisites\n\n### Setup User Configuration\n\n* Pick your Username -\n [FAQ](https://foldingathome.org/support/faq/stats-teams-usernames/).\n* Setup your\n [Passkey](https://foldingathome.org/support/faq/points/passkey/).\n This will give bonus points after completing 10 Work Units on time.\n* Join a team or create your own -\n [FAQ](https://foldingathome.org/support/faq/stats-teams-usernames/).\n* If running inside of a company, make sure management has signed off on both\n your participation with company resources, and the team/user names used.\n\nThese values will be used in your config.xml later.\n\n### Technical Requirements\n\n* Docker 19.03 or later (for single node).\n* Persistent storage for each running container.\n\n#### For AMD GPUs\n\n* Host should have ROCm DKMS drivers installed per the ROCm QuickStart Guide\n \n* Depending on your host OS (e.g. Ubuntu 20.04) you may need to add the 'render'\n group id to the 'docker run' command:\n\n```bash\ndockuser@host$ getent group render\nrender:x:1001:dockuser\ndockuser@host$ docker run -it --device=/dev/kfd --device=/dev/dri \\\n --security-opt seccomp=unconfined \\\n --group-add video --group-add 1001 \\\n --name fah0 -d --user \"$(id -u):$(id -g)\" \\\n --volume $HOME/fah:/fah fah-gpu-amd\n```\n\n## Running on a Single machine\n\nBefore scaling up containers on a cluster or cloud, it's important to be\nfamiliar with the `/fah` storage requirements, life cycle, and\nusage that will complete Work Units and help the research on Folding@home.\nThat starts with one machine.\n\n### Single Machine Setup\n\nOnce the [prerequisites](#prerequisites) are met, it's time to run the\ncontainer.\n\nSee [example config.xml files](#example-config.xml-files) and be sure to\nset your user/passkey/team.\n\n```bash\n# Make a directory for persistent storage\nmkdir $HOME/fah\n\n# Edit config.xml based on an example config below, use vi or other editor.\nvi $HOME/fah/config.xml\n```\n\nOver time config.xml will also have client state, and will be rewritten by\nthe client.\n\n### Start Folding on Single Machine\n\n```bash\n# Run container with GPUs, name it \"fah0\", map user and /fah volume\ndocker run -it --device=/dev/kfd --device=/dev/dri \\\n --security-opt seccomp=unconfined --group-add video \\\n --name fah0 -d --user \"$(id -u):$(id -g)\" \\\n --volume $HOME/fah:/fah fah-gpu-amd\n```\n\n### Monitoring Logs on Single Machine\n\n```bash\n# Dump output so far this run\ndocker logs fah0\n\n# Tail the log\ndocker logs -f fah0\n```\n\n### Stopping the Container on Single Machine\n\n```bash\n# Stop container once Work Units finish (preferred), may take hours\ndocker exec fah0 FAHClient --send-command finish\n\n# Stop container after checkpoint, usually under 30 seconds.\n# Be sure to start it again to let it finish before the Work Units expire.\ndocker exec fah0 FAHClient --send-command shutdown\n# The container can also just be killed, but that's not as nice.\n```\n\n## Running on a Cluster\n\nThere are a lot of container orchestrators, so the requirements are as\nsimple as possible:\n\n* The container orchestration needs to be able to allocate and manage GPUs.\n* Run one container per machine/VM - each client can manage many GPUs and\n CPU cores, and should have a config.xml tuned for the host/VM size.\n* Each running container must have it's own separate persistent storage\n directory mounted into the `/fah` directory of the container. They should\n be reused, but two containers should never be using the same directory.\n\n### Cluster Storage Setup\n\nCreate a root folder on the cluster storage, e.g. `.../root-dir/` and create\nsubdirectories based on one of these methods:\n\nMethod 1: For smaller clusters, having one directory per host is simple. When\nrun the containers can mount `.../root-dir/$hostname/` to `/fah` for the job\nrunning on `hostname`.\n\nMethod 2: For larger clusters, having a pool of directories that can be reused\nbased on how many clients are run. Running them takes more careful management\nbut mounting `.../root-dir/$jobname/` to the `/fah` folder of jobs named\n`fold00` ... `fold99` is the general idea.\n\n_**Before running any clients make sure to copy your customized `config.xml`\nto all the subfolders**_.\n\nOther methods are valid, as long as they meet the requirements above.\n\n### Start Folding on a Cluster\n\nBased on the storage setup, run one container per subfolder, mounting it\ninto `/fah`.\n\n### Monitoring Logs on Single Machine\n\nYour container orchestrator should have commands equivalent to\n`docker logs ...` and `docker exec ...` to perform the same functions.\n\n```bash\n# See how many Work Units have been returned by all clients\ngrep points .../root-dir/*/log.txt .../root-dir/*/logs/*.txt\n```\n\n### Stopping Containers on a Cluster\n\nHow containers are stopped on the cluster will effect how many Work Units are\nlate or lost.\n\n```bash\n# preferred shutdown\n exec FAHClient --send-command finish\n\n# Stop container after checkpoint, usually under 30 seconds.\n exec FAHClient --send-command shutdown\n# The container can also just be killed, but that's not as nice.\n```\n\nThe goal is to **avoid accumulating a lot of subdirectories with unfinished\nWork Units**.\n\nRunning the Folding@home container with low priority on a cluster where it\ngets preempted and resumed will work fine. The `max-units` configuration\noption may also be useful in combination with low priority to use idle\ncapacity where preemption is not available.\n\n## Example config.xml Files\n\nThe config options used for running the client in containers are slightly\ndifferent than the ones used in a standalone install.\nThese are the interesting ones:\n\n* user, passkey, team - user and team. Set them to your values.\n* exit-when-done - have container exit once a finish is sent to it.\n* power - run 100% of the time but idle priority.\n* web-enable, disable-viz, gui-enabled - disable unnecessary things.\n* slots ... - SMP and GPU slots. Each GPU slot also takes 1 CPU core.\n Each SMP slot can be set to use N cores. The \"cpus\" tag can be left out on\n 1-cpu low core count machines and it will autoconfig.\n\nClient help on all the options is available with:\n\n```bash\ndocker run --rm foldingathome/fah-gpu-amd:latest --help\n```\n\n#### 1-GPU, 1-CPU, 16 thread Example Config\n\n```xml\n\n \n \n \n \n\n \n \n\n \n \n \n\n \n \n\n \n \n\n\n```\n\n#### 8-GPU, 2-CPU, 80-thread Example Config\n\n```xml\n\n \n \n \n \n\n \n \n\n \n \n \n\n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n\n\n```\n","has_starred","hub_user","jcoffland","immutable_tags_settings",{"_72":11,"_73":74},"enabled","rules",[75],".*","is_automated","permissions",{"_79":17,"_80":11,"_81":11},"read","write","admin","user","storage_size",175664422,"orgData",{"_87":88,"_89":90,"_91":92,"_93":29,"_94":95,"_96":97,"_98":97,"_99":100,"_101":102,"_103":97,"_104":97,"_105":97,"_106":17},"id","3f9b920e74c011e4bea40242ac11001b","uuid","3f9b920e-74c0-11e4-bea4-0242ac11001b","type","organization","orgname","full_name","foldingathome.org","location","","company","profile_url","https://foldingathome.org/","date_joined","2014-06-26T04:03:08.696598Z","gravatar_url","gravatar_email","badge","is_active","recentTags",[109,146],{"_110":40,"_111":112,"_113":114,"_87":115,"_116":117,"_46":134,"_135":112,"_136":137,"_138":52,"_53":139,"_140":141,"_142":125,"_143":134,"_144":61,"_145":17},"content_type","creator",1613099,"full_size",103138344,192437956,"images",[118],{"_119":120,"_121":122,"_123":97,"_124":125,"_126":127,"_128":129,"_130":97,"_131":-5,"_132":114,"_59":61,"_133":-5},"architecture","amd64","digest","sha256:c9d9498b5cb9f820575f57e0d7669fa3841553c1628ad97abf7caa0b442bc523","features","last_pulled","2026-09-21T21:01:57.041869248Z","last_pushed","2022-02-15T02:55:34Z","os","linux","os_features","os_version","size","variant","2022-02-15T04:42:53.627429Z","last_updater","last_updater_username","beberg","media_type","latest","repository",16378146,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_110":40,"_111":112,"_113":114,"_87":147,"_116":148,"_46":150,"_135":112,"_136":137,"_138":52,"_53":151,"_140":141,"_142":125,"_143":150,"_144":61,"_145":17},192437945,[149],{"_119":120,"_121":122,"_123":97,"_124":125,"_126":127,"_128":129,"_130":97,"_131":-5,"_132":114,"_59":61,"_133":-5},"2022-02-15T04:42:47.01005Z","22.02.0","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":163,"_170":171,"_159":184,"_185":11},{"_36":164,"_38":165,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":166,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":58,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":69,"_70":167,"_76":11,"_77":169,"_82":29,"_83":84},[],[40],[52],{"_72":11,"_73":168},[75],{"_79":17,"_80":11,"_81":11},"tags",{"_172":173,"_174":-5,"_175":-5,"_176":177},"count",2,"next","previous","results",[178,181],{"_110":40,"_111":112,"_113":114,"_87":115,"_116":179,"_46":134,"_135":112,"_136":137,"_138":52,"_53":139,"_140":141,"_142":125,"_143":134,"_144":61,"_145":17},[180],{"_119":120,"_121":122,"_123":97,"_124":125,"_126":127,"_128":129,"_130":97,"_131":-5,"_132":114,"_59":61,"_133":-5},{"_110":40,"_111":112,"_113":114,"_87":147,"_116":182,"_46":150,"_135":112,"_136":137,"_138":52,"_53":151,"_140":141,"_142":125,"_143":150,"_144":61,"_145":17},[183],{"_119":120,"_121":122,"_123":97,"_124":125,"_126":127,"_128":129,"_130":97,"_131":-5,"_132":114,"_59":61,"_133":-5},[],"canDeleteTags","actionData","errors"]

foldingathome/fah-gpu-amd

Tags for foldingathome/fah-gpu-amd