Skip to content

docs: Update Flash concept description to use @Endpoint decorator#565

Merged
muhsinking merged 1 commit intomainfrom
promptless/flash-endpoint-api-concepts
Mar 23, 2026
Merged

docs: Update Flash concept description to use @Endpoint decorator#565
muhsinking merged 1 commit intomainfrom
promptless/flash-endpoint-api-concepts

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Mar 23, 2026

Open this suggestion in Promptless to view citations and reasoning process

Updates the Flash description in the concepts glossary page to reference the new @Endpoint decorator instead of the deprecated @remote decorator, aligning with the unified Endpoint API in Flash PR #223.

Trigger Events

runpod/flash PR #223: refactor: Endpoint class as a single entrypoint uniting `@remote` and ServerlessResource-based classes

Promptless Research (8 files, 1 GitHub PR)

  • Reviewed runpod/flash#223
  • Viewed .long_term_context/product_knowledge/product_overview.md
  • Viewed .long_term_context/doc_workflow/client_instructions.md
  • Viewed flash/quickstart.mdx
  • Viewed flash/create-endpoints.mdx
  • Viewed flash/overview.mdx
  • Viewed flash/configuration/parameters.mdx
  • Viewed get-started/concepts.mdx
  • Viewed .long_term_context/style/client_style_guide.md

Agent Response

I've reviewed PR #223 which introduces the unified Endpoint class for Flash, replacing the legacy @remote decorator and 8 resource config classes.

Summary

Good news: The Flash documentation is already fully updated to use the new Endpoint API. The quickstart, create-endpoints, overview, and parameters pages all use the modern syntax with features like scaler_type, scaler_value, and template already documented.

One update needed: I found a reference to the deprecated @remote decorator in the concepts glossary page (get-started/concepts.mdx) and updated it to reference @Endpoint instead.

Documentation suggestion created

Title: Update Flash concept description to use @endpoint decorator

Change: Updated the Flash description in the concepts glossary from:

Write functions with the @remote decorator...

To:

Write functions with the @Endpoint decorator...

This aligns the concepts page with the rest of the Flash documentation and reflects the unified API introduced in PR #223.

Note: The release notes page contains a historical reference to "Tetra beta test" with @remote() decorator, which I left unchanged since it's documenting a past feature announcement.


Tip: Adjust how proactive or focused Promptless is in Agent Settings ⚙️

## [Flash](/flash/overview)

A framework for building distributed GPU applications using local Python scripts. Write functions with the `@remote` decorator, and Flash automatically executes them on Runpod's infrastructure.
A framework for building distributed GPU applications using local Python scripts. Write functions with the `@Endpoint` decorator, and Flash automatically executes them on Runpod's infrastructure.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: PR #223 introduces the unified Endpoint class that replaces the @remote decorator and 8 resource config classes. The PR description states: "Replaces 8 resource config classes (LiveServerless, CpuLiveServerless, etc.) and the @remote decorator with a single Endpoint class." Legacy classes and @remote now emit DeprecationWarning on import/use.
View source

@mintlify
Copy link

mintlify bot commented Mar 23, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
runpod-docs 🟢 Ready View Preview Mar 23, 2026, 3:03 PM

@promptless
Copy link
Contributor Author

promptless bot commented Mar 23, 2026

Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.)

@muhsinking muhsinking merged commit da55fd3 into main Mar 23, 2026
3 checks passed
@muhsinking muhsinking deleted the promptless/flash-endpoint-api-concepts branch March 23, 2026 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant