[{"data":1,"prerenderedAt":592},["ShallowReactive",2],{"page-\u002Fget-started\u002Fquickstart":3,"surround-\u002Fget-started\u002Fquickstart":583},{"id":4,"title":5,"body":6,"description":575,"extension":576,"meta":577,"navigation":578,"path":579,"seo":580,"stem":581,"__hash__":582},"docs\u002Fget-started\u002Fquickstart.md","Quickstart",{"type":7,"value":8,"toc":568},"minimark",[9,13,18,43,50,54,61,311,314,318,459,463,466,522,525,529,564],[10,11,12],"p",{},"Follow this guide to create an account, deploy your first GPU instance, and run code on it.",[14,15,17],"h2",{"id":16},"step-1-create-an-account","Step 1: Create an account",[19,20,21,40],"ol",{},[22,23,24,25,34,35,39],"li",{},"Open the ",[26,27,33],"a",{"href":28,"rel":29,"target":32},"https:\u002F\u002Fconsole.cloud.featherless.ai",[30,31],"noopener","noreferrer","_blank","console"," and click ",[36,37,38],"strong",{},"Continue with Featherless",".",[22,41,42],{},"Sign in with your featherless.ai account, or create one. The console needs a verified email address.",[10,44,45,46,49],{},"Your account comes with a personal ",[36,47,48],{},"organization",", which owns everything you deploy and the credit that pays for it. Teammates you invite to it later share all of that.",[14,51,53],{"id":52},"step-2-deploy-an-instance","Step 2: Deploy an instance",[10,55,56,57,60],{},"An ",[36,58,59],{},"instance"," is a container running on dedicated GPU or CPU compute. You connect to it from your browser or over SSH.",[62,63,65,211],"tabs",{"sync":64},"interface",[66,67,69,81,201],"tabs-item",{"label":68},"Deploy via the console",[10,70,71,72,77,78,39],{},"On the ",[26,73,76],{"href":74,"rel":75,"target":32},"https:\u002F\u002Fconsole.cloud.featherless.ai\u002Finstances",[30,31],"Instances page",", click ",[36,79,80],{},"Deploy instance",[82,83,85,90,118,122,137,141,162,166,169,173],"steps",{"level":84},"4",[86,87,89],"h4",{"id":88},"configure-deployment","Configure deployment",[91,92,93,112],"ul",{},[22,94,95,98,99,102,103,107,108,111],{},[36,96,97],{},"Template",": a container image with its default settings, ready to deploy. The default, ",[36,100,101],{},"PyTorch (ROCm)",", has Python 3.12, PyTorch and the ROCm GPU libraries installed, with SSH, JupyterLab, and ",[104,105,106],"code",{},"amd-smi"," and ",[104,109,110],{},"nvtop"," for watching the GPU.",[22,113,114,117],{},[36,115,116],{},"Set overrides",": replaces the template's image with another, such as your own, for this instance only.",[86,119,121],{"id":120},"compute","Compute",[91,123,124],{},[22,125,126,107,129,132,133,136],{},[36,127,128],{},"GPU model",[36,130,131],{},"GPU count",": each GPU comes with its own share of CPU and memory, which the ",[36,134,135],{},"Instance summary"," shows.",[86,138,140],{"id":139},"storage-configuration","Storage configuration",[91,142,143,153],{},[22,144,145,148,149,152],{},[36,146,147],{},"Container disk",": the instance's own disk. It holds the image, everything you install, and your files in ",[104,150,151],{},"\u002Fworkspace",". It's erased when the instance stops or restarts, and it's billed only while the instance runs.",[22,154,155,158,159,161],{},[36,156,157],{},"Network volumes",": persistent storage that lives outside the instance. You mount a volume at a path such as ",[104,160,151],{},". It keeps its data when instances stop or are deleted, several instances can share it, and it's billed until you delete it.",[86,163,165],{"id":164},"public-ports","Public ports",[10,167,168],{},"HTTP ports in the container that get their own public HTTPS address, for a notebook, an API or a web app. Anyone with the address can reach them.",[86,170,172],{"id":171},"runtime-configuration","Runtime configuration",[91,174,175,181,191],{},[22,176,177,180],{},[36,178,179],{},"Start command",": replaces the command the image runs on start.",[22,182,183,186,187,190],{},[36,184,185],{},"Environment variables",": passed to the container, and visible on the instance's ",[36,188,189],{},"Details"," tab.",[22,192,193,196,197,200],{},[36,194,195],{},"Secret variables",": encrypted and never shown again. The container reads them as files in ",[104,198,199],{},"\u002Frun\u002Ffeatherless\u002Fsecrets",", not as environment variables.",[10,202,203,204,207,208,39],{},"Click ",[36,205,206],{},"Review launch"," to see the full configuration and hourly rate, then ",[36,209,210],{},"Launch instance",[66,212,214,221,263,266],{"label":213},"Deploy via the CLI",[10,215,216,217,220],{},"Install the CLI and sign in. ",[104,218,219],{},"login"," opens the console to create an API key, then asks you to paste it.",[222,223,228],"pre",{"className":224,"code":225,"language":226,"meta":227,"style":227},"language-bash shiki shiki-themes github-dark-default","curl -fsSL https:\u002F\u002Fconsole.cloud.featherless.ai\u002Finstall.sh | sh\nfeatherless-cloud login\n","bash","",[104,229,230,254],{"__ignoreMap":227},[231,232,235,239,243,247,251],"span",{"class":233,"line":234},"line",1,[231,236,238],{"class":237},"sQhOw","curl",[231,240,242],{"class":241},"sFSAA"," -fsSL",[231,244,246],{"class":245},"s9uIt"," https:\u002F\u002Fconsole.cloud.featherless.ai\u002Finstall.sh",[231,248,250],{"class":249},"suJrU"," |",[231,252,253],{"class":237}," sh\n",[231,255,257,260],{"class":233,"line":256},2,[231,258,259],{"class":237},"featherless-cloud",[231,261,262],{"class":245}," login\n",[10,264,265],{},"Deploy an instance from the PyTorch template on one GPU, and check its status:",[222,267,269],{"className":224,"code":268,"language":226,"meta":227,"style":227},"featherless-cloud instance create --name quickstart --template featherless\u002Frocm-pytorch --gpu-count 1\nfeatherless-cloud instance get quickstart\n",[104,270,271,299],{"__ignoreMap":227},[231,272,273,275,278,281,284,287,290,293,296],{"class":233,"line":234},[231,274,259],{"class":237},[231,276,277],{"class":245}," instance",[231,279,280],{"class":245}," create",[231,282,283],{"class":241}," --name",[231,285,286],{"class":245}," quickstart",[231,288,289],{"class":241}," --template",[231,291,292],{"class":245}," featherless\u002Frocm-pytorch",[231,294,295],{"class":241}," --gpu-count",[231,297,298],{"class":241}," 1\n",[231,300,301,303,305,308],{"class":233,"line":256},[231,302,259],{"class":237},[231,304,277],{"class":245},[231,306,307],{"class":245}," get",[231,309,310],{"class":245}," quickstart\n",[10,312,313],{},"Before the container starts, the instance waits for a GPU and downloads its image. The first start of an image can take a few minutes; later starts are faster. Billing is per second and starts when the container starts, not while you wait.",[14,315,317],{"id":316},"step-3-run-code-on-your-instance","Step 3: Run code on your instance",[62,319,321,371],{"sync":320},"connect",[66,322,324,334,337,353,364],{"label":323},"Browser",[10,325,326,327,330,331,333],{},"Open the instance's ",[36,328,329],{},"Terminal"," tab. You get a root shell in ",[104,332,151],{},", with a banner showing the instance's GPUs, hourly cost and storage.",[10,335,336],{},"Check that PyTorch can use the GPU:",[222,338,340],{"className":224,"code":339,"language":226,"meta":227,"style":227},"python -c \"import torch; print(torch.cuda.is_available(), torch.cuda.get_device_name(0))\"\n",[104,341,342],{"__ignoreMap":227},[231,343,344,347,350],{"class":233,"line":234},[231,345,346],{"class":237},"python",[231,348,349],{"class":241}," -c",[231,351,352],{"class":245}," \"import torch; print(torch.cuda.is_available(), torch.cuda.get_device_name(0))\"\n",[10,354,355,356,359,360,363],{},"It prints ",[104,357,358],{},"True"," and the GPU's name. On AMD GPUs, PyTorch's ",[104,361,362],{},"torch.cuda"," API drives the GPU through ROCm, so CUDA code runs unchanged.",[10,365,366,367,370],{},"The terminal runs in ",[36,368,369],{},"tmux",", which keeps your shell and programs running after you close the tab, until the instance stops.",[66,372,374,448],{"label":373},"SSH",[19,375,376,397,433],{},[22,377,378,379,384,385,388,389,392,393,396],{},"Add your public key on the ",[26,380,383],{"href":381,"rel":382,"target":32},"https:\u002F\u002Fconsole.cloud.featherless.ai\u002Fcredentials\u002Fssh-keys",[30,31],"Credentials page"," with ",[36,386,387],{},"Add key",". No key yet? Create one with ",[104,390,391],{},"ssh-keygen -t ed25519","; the public key is ",[104,394,395],{},"~\u002F.ssh\u002Fid_ed25519.pub",". One key works for every instance in your organization.",[22,398,399,400,403,404,39,407],{},"The instance's ",[36,401,402],{},"Connect"," tab shows the SSH command once SSH is ready. You log in as ",[104,405,406],{},"root",[222,408,410],{"className":224,"code":409,"language":226,"meta":227,"style":227},"ssh \u003Cinstance-id>@ssh.cloud.featherless.ai\n",[104,411,412],{"__ignoreMap":227},[231,413,414,417,420,423,427,430],{"class":233,"line":234},[231,415,416],{"class":237},"ssh",[231,418,419],{"class":249}," \u003C",[231,421,422],{"class":245},"instance-i",[231,424,426],{"class":425},"sZEs4","d",[231,428,429],{"class":249},">",[231,431,432],{"class":245},"@ssh.cloud.featherless.ai\n",[22,434,435,436],{},"Run the same check:",[222,437,438],{"className":224,"code":339,"language":226,"meta":227,"style":227},[104,439,440],{"__ignoreMap":227},[231,441,442,444,446],{"class":233,"line":234},[231,443,346],{"class":237},[231,445,349],{"class":241},[231,447,352],{"class":245},[10,449,450,451,454,455,458],{},"The same SSH command works for ",[104,452,453],{},"scp",", ",[104,456,457],{},"rsync"," and remote development in VS Code or Cursor.",[14,460,462],{"id":461},"step-4-clean-up","Step 4: Clean up",[10,464,465],{},"A running instance is billed whether or not you're using it, until you stop or delete it.",[62,467,468,492],{"sync":64},[66,469,471],{"label":470},"Console",[91,472,473,482],{},[22,474,475,478,479,481],{},[36,476,477],{},"Stop",": keeps the instance's settings, so you can start it again later. Click ",[36,480,477],{}," on the instance's page.",[22,483,484,487,488,491],{},[36,485,486],{},"Delete",": removes the instance and its settings. Click ",[36,489,490],{},"Delete instance"," in the instance's actions menu.",[66,493,495],{"label":494},"CLI",[222,496,498],{"className":224,"code":497,"language":226,"meta":227,"style":227},"featherless-cloud instance stop quickstart\nfeatherless-cloud instance delete quickstart\n",[104,499,500,511],{"__ignoreMap":227},[231,501,502,504,506,509],{"class":233,"line":234},[231,503,259],{"class":237},[231,505,277],{"class":245},[231,507,508],{"class":245}," stop",[231,510,310],{"class":245},[231,512,513,515,517,520],{"class":233,"line":256},[231,514,259],{"class":237},[231,516,277],{"class":245},[231,518,519],{"class":245}," delete",[231,521,310],{"class":245},[10,523,524],{},"If your credit runs out, running instances are stopped for you.",[14,526,528],{"id":527},"next-steps","Next steps",[530,531,532,541,548,556],"card-group",{},[533,534,538],"card",{"icon":535,"title":536,"to":537},"i-lucide-server","Deploy an instance","\u002Finstances\u002Fdeploy",[10,539,540],{},"Every setting on the deploy page.",[533,542,545],{"icon":543,"title":157,"to":544},"i-lucide-database","\u002Fstorage\u002Fnetwork-volumes",[10,546,547],{},"Keep datasets, models and checkpoints between runs.",[533,549,553],{"icon":550,"title":551,"to":552},"i-lucide-flask-conical","Examples","\u002Fexamples",[10,554,555],{},"JupyterLab, model serving and fine-tuning, end to end.",[533,557,561],{"icon":558,"title":559,"to":560},"i-lucide-terminal","Install the CLI","\u002Fcli",[10,562,563],{},"Manage everything from your terminal.",[565,566,567],"style",{},"html pre.shiki code .sQhOw, html code.shiki .sQhOw{--shiki-default:#FFA657}html pre.shiki code .sFSAA, html code.shiki .sFSAA{--shiki-default:#79C0FF}html pre.shiki code .s9uIt, html code.shiki .s9uIt{--shiki-default:#A5D6FF}html pre.shiki code .suJrU, html code.shiki .suJrU{--shiki-default:#FF7B72}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html pre.shiki code .sZEs4, html code.shiki .sZEs4{--shiki-default:#E6EDF3}",{"title":227,"searchDepth":256,"depth":256,"links":569},[570,571,572,573,574],{"id":16,"depth":256,"text":17},{"id":52,"depth":256,"text":53},{"id":316,"depth":256,"text":317},{"id":461,"depth":256,"text":462},{"id":527,"depth":256,"text":528},"Run code on a dedicated GPU in minutes, starting from a new account.","md",{},true,"\u002Fget-started\u002Fquickstart",{"title":5,"description":575},"get-started\u002Fquickstart","Vfisi5gC03gQi6gxQU_UkRIWAciRqjzLPqZOM2k5hiA",[584,588],{"title":585,"path":586,"description":587},"Featherless GPU Cloud","\u002F","Deploy dedicated GPUs in minutes and pay by the second.",{"title":589,"path":590,"description":591},"Concepts","\u002Fget-started\u002Fconcepts","The building blocks of Featherless GPU Cloud and how they fit together.",1794932598272]