{ "cells": [ { "cell_type": "markdown", "id": "2f04eee0-5928-4e74-a754-6dc2e528810c", "metadata": {}, "source": [ "# Mammalian2" ] }, { "cell_type": "markdown", "id": "a3f514a3-772c-4a14-afdf-5a8376851ff4", "metadata": {}, "source": [ "## Index\n", "1. [Instantiate model class](#Instantiate-model-class)\n", "2. [Define clock metadata](#Define-clock-metadata)\n", "3. [Download clock dependencies](#Download-clock-dependencies)\n", "5. [Load features](#Load-features)\n", "6. [Load weights into base model](#Load-weights-into-base-model)\n", "7. [Load reference values](#Load-reference-values)\n", "8. [Load preprocess and postprocess objects](#Load-preprocess-and-postprocess-objects)\n", "10. [Check all clock parameters](#Check-all-clock-parameters)\n", "10. [Basic test](#Basic-test)\n", "11. [Save torch model](#Save-torch-model)\n", "12. [Clear directory](#Clear-directory)" ] }, { "cell_type": "markdown", "id": "d95fafdc-643a-40ea-a689-200bd132e90c", "metadata": {}, "source": [ "Let's first import some packages:" ] }, { "cell_type": "code", "execution_count": 1, "id": "4adfb4de-cd79-4913-a1af-9e23e9e236c9", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:54:16.531446Z", "iopub.status.busy": "2025-04-07T17:54:16.531147Z", "iopub.status.idle": "2025-04-07T17:54:18.064865Z", "shell.execute_reply": "2025-04-07T17:54:18.064555Z" } }, "outputs": [], "source": [ "import os\n", "import inspect\n", "import shutil\n", "import json\n", "import torch\n", "import pandas as pd\n", "import pyaging as pya\n", "import numpy as np" ] }, { "cell_type": "markdown", "id": "145082e5-ced4-47ae-88c0-cb69773e3c5a", "metadata": {}, "source": [ "## Instantiate model class" ] }, { "cell_type": "code", "execution_count": 2, "id": "8aa77372-7ed3-4da7-abc9-d30372106139", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:54:18.066564Z", "iopub.status.busy": "2025-04-07T17:54:18.066338Z", "iopub.status.idle": "2025-04-07T17:54:18.073979Z", "shell.execute_reply": "2025-04-07T17:54:18.073728Z" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "class Mammalian2(pyagingModel):\n", " def __init__(self):\n", " super().__init__()\n", "\n", " def forward(self, x):\n", " x_cpg = x[:, :-1756] # number of species in lookup table\n", " x_species = x[:, -1756:] # number of species in lookup table\n", " x = self.base_model(x_cpg)\n", " x = self.postprocess(x, x_species)\n", " return x\n", "\n", " def preprocess(self, x):\n", " return x\n", "\n", " def postprocess(self, x, x_species):\n", " \"\"\"\n", " Converts output of relative age to age in units of years.\n", " \"\"\"\n", " indices = torch.argmax(x_species, dim=1)\n", " anage_array = self.postprocess_dependencies[0]\n", " anage_tensor = torch.tensor(anage_array, dtype=x.dtype, device=x.device)\n", " gestation_time = anage_tensor[indices, 0].unsqueeze(1)\n", " max_age = anage_tensor[indices, 3].unsqueeze(1)\n", "\n", " x = torch.exp(-torch.exp(-x))\n", " x = x * (max_age + gestation_time) - gestation_time\n", " return x\n", "\n" ] } ], "source": [ "def print_entire_class(cls):\n", " source = inspect.getsource(cls)\n", " print(source)\n", "\n", "print_entire_class(pya.models.Mammalian2)" ] }, { "cell_type": "code", "execution_count": 3, "id": "78536494-f1d9-44de-8583-c89a310d2307", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:54:18.075222Z", "iopub.status.busy": "2025-04-07T17:54:18.075137Z", "iopub.status.idle": "2025-04-07T17:54:18.076681Z", "shell.execute_reply": "2025-04-07T17:54:18.076444Z" } }, "outputs": [], "source": [ "model = pya.models.Mammalian2()" ] }, { "cell_type": "markdown", "id": "51f8615e-01fa-4aa5-b196-3ee2b35d261c", "metadata": {}, "source": [ "## Define clock metadata" ] }, { "cell_type": "code", "execution_count": 4, "id": "6601da9e-8adc-44ee-9308-75e3cd31b816", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:54:18.077921Z", "iopub.status.busy": "2025-04-07T17:54:18.077842Z", "iopub.status.idle": "2025-04-07T17:54:18.079798Z", "shell.execute_reply": "2025-04-07T17:54:18.079563Z" } }, "outputs": [], "source": [ "model.metadata[\"clock_name\"] = \"mammalian2\"\n", "model.metadata[\"data_type\"] = \"DNA methylation\" # Paper: methylation\n", "model.metadata[\"species\"] = \"multiple species\" # Paper: multi\n", "model.metadata[\"year\"] = 2023\n", "model.metadata[\"approved_by_author\"] = \"⌛\"\n", "model.metadata[\"citation\"] = \"Lu, A. T., et al. \\\"Universal DNA methylation age across mammalian tissues.\\\" Nature Aging 3.9 (2023): 1144-1166.\"\n", "model.metadata[\"doi\"] = \"https://doi.org/10.1038/s43587-023-00462-6\"\n", "model.metadata[\"notes\"] = \"Universal pan-mammalian clock 2 fits relative age (age divided by species maximum lifespan) and the author inverse transformation returns species-adjusted chronological age in years.\"\n", "model.metadata[\"research_only\"] = None\n", "model.metadata[\"tissue\"] = [\"multi-tissue\"] # Paper: multi-tissue\n", "model.metadata[\"predicts\"] = [\"chronological age\"] # Paper: The official inverse transformation returns DNAm chronological age in years.\n", "model.metadata[\"training_target\"] = [\"relative age\"] # Paper: relative age\n", "model.metadata[\"unit\"] = [\"years\"] # Paper: The official inverse transformation returns DNAm chronological age in years.\n", "model.metadata[\"model_type\"] = \"elastic net regression\" # Paper: Elastic net\n", "model.metadata[\"platform\"] = [\"Horvath MammalMethylChip40\"] # Paper: HorvathMammalMethylChip40\n", "model.metadata[\"population\"] = \"multiple mammalian species\" # Paper: 11,754 samples from 185 mammalian species, prenatal to 139 years\n", "model.metadata[\"journal\"] = \"Nature Aging\"\n", "model.metadata[\"last_author\"] = \"Steve Horvath\"\n", "model.metadata[\"n_features\"] = 2572\n", "model.metadata[\"citations\"] = 390\n", "model.metadata[\"citations_date\"] = \"2026-07-05\"\n" ] }, { "cell_type": "markdown", "id": "74492239-5aae-4026-9d90-6bc9c574c110", "metadata": {}, "source": [ "## Download clock dependencies" ] }, { "cell_type": "markdown", "id": "5881f33e-0486-45d1-bd87-9c995f47ca62", "metadata": {}, "source": [ "#### Download GitHub repository" ] }, { "cell_type": "code", "execution_count": 5, "id": "e85525f7-6da4-4962-a7d5-0607e76eea33", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:54:18.081116Z", "iopub.status.busy": "2025-04-07T17:54:18.081035Z", "iopub.status.idle": "2025-04-07T17:56:06.841318Z", "shell.execute_reply": "2025-04-07T17:56:06.840939Z" } }, "outputs": [ { "data": { "text/plain": [ "0" ] }, "execution_count": 5, "metadata": {}, "output_type": "execute_result" } ], "source": [ "github_url = \"https://github.com/shorvath/MammalianMethylationConsortium.git\"\n", "github_folder_name = github_url.split('/')[-1].split('.')[0]\n", "os.system(f\"git clone {github_url}\")" ] }, { "cell_type": "markdown", "id": "047debfa-2c1e-4f76-bb11-4893ecb3d1e8", "metadata": {}, "source": [ "#### Download from R package" ] }, { "cell_type": "code", "execution_count": 6, "id": "d81f2c9d-362f-43cb-ad52-012e28217164", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:56:06.842860Z", "iopub.status.busy": "2025-04-07T17:56:06.842740Z", "iopub.status.idle": "2025-04-07T17:56:06.845290Z", "shell.execute_reply": "2025-04-07T17:56:06.845041Z" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "Writing download.r\n" ] } ], "source": [ "%%writefile download.r\n", "\n", "options(repos = c(CRAN = \"https://cloud.r-project.org/\"))\n", "\n", "myinput.list=readRDS('MammalianMethylationConsortium/UniversalPanMammalianClock/ClockParameters/mydata_GitHub.Rds')\n", "anage=myinput.list[[3]]\n", "anage=subset(anage,select=c(SpeciesLatinName,GestationTimeInYears, averagedMaturity.yrs,maxAge))\n", "anage$HighmaxAge=1.3*anage$maxAge\n", "anage$HighmaxAge[anage$SpeciesLatinName=='Homo sapiens']=anage$maxAge[anage$SpeciesLatinName=='Homo sapiens']\n", "anage$HighmaxAge[anage$SpeciesLatinName=='Mus musculus']=anage$maxAge[anage$SpeciesLatinName=='Mus musculus']\n", "write.csv(anage, \"species_annotation.csv\")" ] }, { "cell_type": "code", "execution_count": 7, "id": "1ce2bac8-dd33-46cb-a7b6-14a1d0976f05", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:56:06.846505Z", "iopub.status.busy": "2025-04-07T17:56:06.846399Z", "iopub.status.idle": "2025-04-07T17:56:07.459930Z", "shell.execute_reply": "2025-04-07T17:56:07.459484Z" } }, "outputs": [ { "data": { "text/plain": [ "0" ] }, "execution_count": 7, "metadata": {}, "output_type": "execute_result" } ], "source": [ "os.system(\"Rscript download.r\")" ] }, { "cell_type": "markdown", "id": "5035b180-3d1b-4432-8ebe-b9c92bd93a7f", "metadata": {}, "source": [ "## Load features" ] }, { "cell_type": "markdown", "id": "15f4af76-b93c-438c-b57f-f129d6e9ec99", "metadata": {}, "source": [ "#### From CSV file" ] }, { "cell_type": "code", "execution_count": 8, "id": "8a3d5de6-6303-487a-8b4d-e6345792f7be", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:56:07.461588Z", "iopub.status.busy": "2025-04-07T17:56:07.461464Z", "iopub.status.idle": "2025-04-07T17:56:07.476094Z", "shell.execute_reply": "2025-04-07T17:56:07.475270Z" } }, "outputs": [], "source": [ "df = pd.read_csv('MammalianMethylationConsortium/UniversalPanMammalianClock/ClockParameters/clock2.csv')\n", "df['feature'] = df['var']\n", "df['coefficient'] = df['beta_clock2']\n", "cpg_features = df['feature'][1:].tolist()\n", "\n", "anage_df = pd.read_csv('species_annotation.csv', index_col=0)\n", "anage_df = anage_df[~anage_df['HighmaxAge'].isna()]\n", "anage_df = anage_df[~anage_df['GestationTimeInYears'].isna()]\n", "anage_df = anage_df.reset_index().drop('index', axis=1)\n", "anage_df = anage_df.fillna(0)\n", "species_features = anage_df['SpeciesLatinName'].tolist()\n", "\n", "model.features = cpg_features + species_features" ] }, { "cell_type": "markdown", "id": "ee6d8fa0-4767-4c45-9717-eb1c95e2ddc0", "metadata": {}, "source": [ "## Load weights into base model" ] }, { "cell_type": "code", "execution_count": 9, "id": "e09b3463-4fd4-41b1-ac21-e63ddd223fe0", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:56:07.479613Z", "iopub.status.busy": "2025-04-07T17:56:07.479398Z", "iopub.status.idle": "2025-04-07T17:56:07.483148Z", "shell.execute_reply": "2025-04-07T17:56:07.482214Z" } }, "outputs": [], "source": [ "weights = torch.tensor(df['coefficient'][1:].tolist()).unsqueeze(0)\n", "intercept = torch.tensor([df['coefficient'][0]])" ] }, { "cell_type": "markdown", "id": "ad261636-5b00-4979-bb1d-67a851f7aa19", "metadata": {}, "source": [ "#### Linear model" ] }, { "cell_type": "code", "execution_count": 10, "id": "d7f43b99-26f2-4622-9a76-316712058877", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:56:07.486416Z", "iopub.status.busy": "2025-04-07T17:56:07.486056Z", "iopub.status.idle": "2025-04-07T17:56:07.490279Z", "shell.execute_reply": "2025-04-07T17:56:07.489264Z" } }, "outputs": [], "source": [ "base_model = pya.models.LinearModel(input_dim=len(model.features))\n", "\n", "base_model.linear.weight.data = weights.float()\n", "base_model.linear.bias.data = intercept.float()\n", "\n", "model.base_model = base_model" ] }, { "cell_type": "markdown", "id": "ad8b4c1d-9d57-48b7-9a30-bcfea7b747b1", "metadata": {}, "source": [ "## Load reference values" ] }, { "cell_type": "code", "execution_count": 11, "id": "ade0f4c9-2298-4fc3-bb72-d200907dd731", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:56:07.493334Z", "iopub.status.busy": "2025-04-07T17:56:07.493131Z", "iopub.status.idle": "2025-04-07T17:56:07.496720Z", "shell.execute_reply": "2025-04-07T17:56:07.495694Z" } }, "outputs": [], "source": [ "reference_list = np.array([0] * len(model.features))\n", "reference_list[len(cpg_features) + np.where(anage_df.SpeciesLatinName == 'Homo sapiens')[0][0]] = 0.5\n", "model.reference_values = reference_list" ] }, { "cell_type": "markdown", "id": "af3bcf7b-74a8-4d21-9ccb-4de0c2b0516b", "metadata": {}, "source": [ "## Load preprocess and postprocess objects" ] }, { "cell_type": "code", "execution_count": 12, "id": "7a22fb20-c605-424d-8efb-7620c2c0755c", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:56:07.499371Z", "iopub.status.busy": "2025-04-07T17:56:07.499231Z", "iopub.status.idle": "2025-04-07T17:56:07.500962Z", "shell.execute_reply": "2025-04-07T17:56:07.500668Z" } }, "outputs": [], "source": [ "model.preprocess_name = None\n", "model.preprocess_dependencies = None" ] }, { "cell_type": "code", "execution_count": 13, "id": "ff4a21cb-cf41-44dc-9ed1-95cf8aa15772", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:56:07.502346Z", "iopub.status.busy": "2025-04-07T17:56:07.502226Z", "iopub.status.idle": "2025-04-07T17:56:07.505700Z", "shell.execute_reply": "2025-04-07T17:56:07.504904Z" } }, "outputs": [], "source": [ "model.postprocess_name = 'mammalian2'\n", "anage_df = anage_df.loc[:, ['GestationTimeInYears','averagedMaturity.yrs', 'maxAge',\t'HighmaxAge']]\n", "anage_array = np.array(anage_df)\n", "model.postprocess_dependencies = [anage_array]" ] }, { "cell_type": "markdown", "id": "86e3d6b1-e67e-4f3d-bd39-0ebec5726c3c", "metadata": {}, "source": [ "## Check all clock parameters" ] }, { "cell_type": "code", "execution_count": 14, "id": "2168355c-47d9-475d-b816-49f65e74887c", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:56:07.509192Z", "iopub.status.busy": "2025-04-07T17:56:07.508970Z", "iopub.status.idle": "2025-04-07T17:56:07.517964Z", "shell.execute_reply": "2025-04-07T17:56:07.517249Z" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "\n", "%==================================== Model Details ====================================%\n", "Model Attributes:\n", "\n", "training: True\n", "metadata: {'approved_by_author': '⌛',\n", " 'citation': 'Lu, A. T., et al. \"Universal DNA methylation age across '\n", " 'mammalian tissues.\" Nature aging 3.9 (2023): 1144-1166.',\n", " 'clock_name': 'mammalian2',\n", " 'data_type': 'methylation',\n", " 'doi': 'https://doi.org/10.1038/s43587-023-00462-6',\n", " 'notes': None,\n", " 'research_only': None,\n", " 'species': 'multi',\n", " 'version': None,\n", " 'year': 2023}\n", "reference_values: array([0, 0, 0, ..., 0, 0, 0])\n", "preprocess_name: None\n", "preprocess_dependencies: None\n", "postprocess_name: 'mammalian2'\n", "postprocess_dependencies: [array([[2.19178082e-02, 2.49315068e+00, 3.60000000e+01, 4.68000000e+01],\n", " [1.64383562e-02, 3.00000000e+00, 1.15000000e+01, 1.49500000e+01],\n", " [3.01369863e-02, 4.50000000e+00, 1.50000000e+01, 1.95000000e+01],\n", " ...,\n", " [5.60876712e-01, 3.05123288e+00, 2.30000000e+01, 2.99000000e+01],\n", " [9.87671233e-02, 1.01706849e+00, 3.50000000e+00, 4.55000000e+00],\n", " [3.15068493e-01, 4.58334000e-01, 2.70000000e+01, 3.51000000e+01]])]\n", "features: ['cg00020468', 'cg00096922', 'cg00098422', 'cg00106940', 'cg00195533', 'cg00250826', 'cg00258262', 'cg00314427', 'cg00362836', 'cg00384342', 'cg00454305', 'cg00467357', 'cg00489428', 'cg00568797', 'cg00593462', 'cg00643485', 'cg00689383', 'cg00694357', 'cg00788877', 'cg00864083', 'cg00871371', 'cg00929113', 'cg00975350', 'cg00984060', 'cg01019040', 'cg01038105', 'cg01061575', 'cg01063757', 'cg01090334', 'cg01137681']... [Total elements: 2572]\n", "base_model_features: None\n", "\n", "%==================================== Model Details ====================================%\n", "Model Structure:\n", "\n", "base_model: LinearModel(\n", " (linear): Linear(in_features=2572, out_features=1, bias=True)\n", ")\n", "\n", "%==================================== Model Details ====================================%\n", "Model Parameters and Weights:\n", "\n", "base_model.linear.weight: [-0.0023850149009376764, -0.009445006027817726, 0.05580539628863335, -0.05914490297436714, -0.17265929281711578, 0.007619396783411503, 0.05367890000343323, -0.0786888375878334, 0.059616584330797195, -0.06562892347574234, -0.03485381603240967, -0.04281875863671303, 0.25934743881225586, 0.0007044760277494788, 0.10228588432073593, 0.10615047067403793, -0.019021064043045044, -0.2263999730348587, -0.010860024020075798, 0.0790414959192276, -0.10834652930498123, -0.01996506378054619, -0.08477586507797241, 0.026488320901989937, -0.022070782259106636, -0.09377875924110413, 0.03151073679327965, -0.09552916139364243, 0.04006564989686012, 0.03320020064711571]... [Tensor of shape torch.Size([1, 816])]\n", "base_model.linear.bias: tensor([-1.9114])\n", "\n", "%==================================== Model Details ====================================%\n", "\n" ] } ], "source": [ "pya.utils.print_model_details(model)" ] }, { "cell_type": "markdown", "id": "986d0262-e0c7-4036-b687-dee53ba392fb", "metadata": {}, "source": [ "## Basic test" ] }, { "cell_type": "code", "execution_count": 15, "id": "936b9877-d076-4ced-99aa-e8d4c58c5caf", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:56:07.521112Z", "iopub.status.busy": "2025-04-07T17:56:07.520768Z", "iopub.status.idle": "2025-04-07T17:56:07.529261Z", "shell.execute_reply": "2025-04-07T17:56:07.528411Z" } }, "outputs": [ { "data": { "text/plain": [ "tensor([[-6.2466e-01],\n", " [-3.6986e-01],\n", " [ 1.0588e+01],\n", " [ 1.4034e+01],\n", " [ 3.4747e+01],\n", " [ 1.1834e-02],\n", " [-6.6003e-01],\n", " [-8.2192e-02],\n", " [ 9.9949e-01],\n", " [-3.5616e-02]], dtype=torch.float64, grad_fn=)" ] }, "execution_count": 15, "metadata": {}, "output_type": "execute_result" } ], "source": [ "torch.manual_seed(42)\n", "input = torch.randn(10, len(model.features), dtype=float)\n", "model.eval()\n", "model.to(float)\n", "pred = model(input)\n", "pred" ] }, { "cell_type": "markdown", "id": "fe8299d7-9285-4e22-82fd-b664434b4369", "metadata": {}, "source": [ "## Save torch model" ] }, { "cell_type": "code", "execution_count": 16, "id": "5ef2fa8d-c80b-4fdd-8555-79c0d541788e", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:56:07.532402Z", "iopub.status.busy": "2025-04-07T17:56:07.532101Z", "iopub.status.idle": "2025-04-07T17:56:07.537913Z", "shell.execute_reply": "2025-04-07T17:56:07.537277Z" } }, "outputs": [], "source": [ "torch.save(model, f\"../weights/{model.metadata['clock_name']}.pt\")" ] }, { "cell_type": "markdown", "id": "bac6257b-8d08-4a90-8d0b-7f745dc11ac1", "metadata": {}, "source": [ "## Clear directory\n", "" ] }, { "cell_type": "code", "execution_count": 17, "id": "11aeaa70-44c0-42f9-86d7-740e3849a7a6", "metadata": { "execution": { "iopub.execute_input": "2025-04-07T17:56:07.540422Z", "iopub.status.busy": "2025-04-07T17:56:07.540285Z", "iopub.status.idle": "2025-04-07T17:56:07.688022Z", "shell.execute_reply": "2025-04-07T17:56:07.687703Z" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "Deleted file: species_annotation.csv\n", "Deleted folder: MammalianMethylationConsortium\n", "Deleted file: download.r\n" ] } ], "source": [ "# Function to remove a folder and all its contents\n", "def remove_folder(path):\n", " try:\n", " shutil.rmtree(path)\n", " print(f\"Deleted folder: {path}\")\n", " except Exception as e:\n", " print(f\"Error deleting folder {path}: {e}\")\n", "\n", "# Get a list of all files and folders in the current directory\n", "all_items = os.listdir('.')\n", "\n", "# Loop through the items\n", "for item in all_items:\n", " # Check if it's a file and does not end with .ipynb\n", " if os.path.isfile(item) and not item.endswith('.ipynb'):\n", " os.remove(item)\n", " print(f\"Deleted file: {item}\")\n", " # Check if it's a folder\n", " elif os.path.isdir(item):\n", " remove_folder(item)" ] } ], "metadata": { "kernelspec": { "display_name": "Python 3", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.9.7" } }, "nbformat": 4, "nbformat_minor": 5 }