Skip to content

Doc: enable search #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wangvsa merged 3 commits into from
Jun 6, 2026
Merged

Doc: enable search #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09324a0
Doc: enable search
JaeseungYeom Jun 5, 2026
290d1d1
Doc:enlarge the diagram by reducing margins
JaeseungYeom Jun 6, 2026
07c9f89
Docs: minor tweak
JaeseungYeom Jun 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
<p align="center">
<!-- Mother Project Logo on the Left -->
<img src="https://raw.githubusercontent.com/flux-framework/.github/main/images/logo.png" height="50" align="middle" alt="Flux">
<img src="https://raw.githubusercontent.com/flux-framework/.github/main/images/logo.png" height="30" align="middle" alt="Flux">
<!-- Your Project Name in the Middle -->
<span style="font-size: 2.2em; font-weight: bold; margin: 0 20px; valign: middle;">DYAD: DYnamic and Asynchronous Data Streamliner</span>

<span style="font-size: 2.2em; font-weight: bold; margin: 0 20px; valign: middle;"> ** DYAD: DYnamic and Asynchronous Data Streamliner ** </span>
<!-- Your Subproject Logo on the Right -->
<img src="docs/_static/logo/dyad_logo_sky_blue.svg" height="50" align="middle" alt="DYAD">
<img src="docs/_static/logo/dyad_logo_sky_blue.svg" height="40" align="middle" alt="DYAD">
</p>

---
Expand Down
6 changes: 3 additions & 3 deletions docs/_fragments/design_overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Overview of Synchronization and File Transfer

DYAD consists of two components: a :ref:`**wrapper**<dyad_user_api>` library that is injected
into the application process via ``LD_PRELOAD`` or C++ stream wrapper
classes to transparently intercept I/O calls, and a :ref:`**service**<dyad_user_service>` that
classes to transparently intercept I/O calls, and a :ref:`**service**<DYAD_user_service>` that
runs as a plugin module to the Flux broker on each node. Together they
coordinate file access and transfer between nodes.

The wrapper intercepts I/O only for files in the directory it manages,
or :ref:`DYAD managed directory (DMD)<dyad_managed_dir>`. If the file shared between producer and
or :ref:`DYAD managed directory (DMD)<DYAD_managed_dir>`. If the file shared between producer and
consumer under DMD resides on the producer's local storage that is not
visible to the consumer, DYAD both synchronizes accesses and transfers
files to the DMD on the consumer's local storage. If it is visible to
Expand Down Expand Up @@ -52,7 +52,7 @@ occur in order (see **c.1–c.3** in the diagram):
query when it sees the matching entry, which propagates from the
producer's local HFL through the hierarchy.
2. **c.2** ``rpc_get(producer_rank, filename)`` — the wrapper sends an
RPC to the producer's :ref:`DYAD service<dyad_user_service>` requesting the file. The service
RPC to the producer's :ref:`DYAD service<DYAD_user_service>` requesting the file. The service
transfers the file over the selected :ref:`DTL backend<dyad_dtl>` (Flux RPC, Margo, or
UCX) and stores it on the consumer's local storage.
3. **c.3** ``read(managed_dir/filename)`` — the application reads the
Expand Down
Loading
Loading