Skip to content
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.

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

create new branch with simplified README and introduction #1002

Merged
merged 20 commits into from
May 17, 2023

Conversation

jlnav
Copy link
Member

@jlnav jlnav commented May 1, 2023

Now it'll be easier to discuss changes to the README and rtd splash-page independent of other changes I'm making.

This doesn't have to come in for this release, maybe for 1.0

@jlnav jlnav marked this pull request as ready for review May 3, 2023 14:59
@jlnav jlnav requested review from jmlarson1 and shuds13 May 3, 2023 14:59
README.rst Outdated
libEnsemble helps users take advantage of massively parallel resources to solve design,
decision, and inference problems and expands the class of problems that can benefit from
increased parallelism.
• **Adaptive ensembles**: Generate parallel tasks on-the-fly based on previous computations.
Copy link
Member

Choose a reason for hiding this comment

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

Heres my effort:

  • Dynamic ensembles: Generate new tasks on-the-fly based on previous computations.
  • Extreme scaling: Run identical scripts on or across_ laptops, clusters, and leadership-class machines.
  • Dynamic resource management: Dynamically assign and reassign CPU/GPU resources to tasks.
  • Application monitoring: Ensemble members can run, monitor, and cancel apps.
  • Heterogeneous resources Automatic detection and correct assignment on Nvidia, AMD and Intel GPUs.
  • Low start-up cost: No additional background services or processes required.

Thoughts?

Copy link
Member

Choose a reason for hiding this comment

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

In Dynamic resources

we have dropped: "partitions of any size" (e.g. nodes) - which to my mind made clear it included nodes, but I'm guessing thats obvious already

Copy link
Member

Choose a reason for hiding this comment

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

Coordinated data-flow between tasks - does this mean via the manager? I'm not sure about this one.

Copy link
Member Author

Choose a reason for hiding this comment

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

Here's my effort:

Looks good! But I wonder if there's a way of combining the Dynamic resource management and Heterogeneous resources sections?

In Dynamic resources

Yeah, that's what I was thinking. Plus "nodes" is covered in my mind by "extreme scaling".

Coordinated data-flow between tasks - does this mean via the manager? I'm not sure about this one.

I'm trying to emphasize that the tasks don't exist independently, each in a "bubble" (which is the case for most multi-task workflow systems). They can communicate state with the manager and each other

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh yeah, I'm also trying to avoid redundant adjectives whenever possible.

@@ -271,102 +82,14 @@ Resources
doi = {10.1109/tpds.2021.3082815}
}

**Example Compatible Packages**
Copy link
Member

Choose a reason for hiding this comment

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

As we have community examples, we should prob have a link to that.

Copy link
Member Author

Choose a reason for hiding this comment

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

Community Examples is still linked to on line 67 on the right

- OPAL_ Object Oriented Parallel Accelerator Library. (See this `IPAC manuscript`_.)
- WarpX_ Advanced electromagnetic particle-in-cell code. (See example `WarpX + libE scripts`_.)

See a complete list of `example user scripts`_.
Copy link
Member

Choose a reason for hiding this comment

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

Is this link to examples somewhere (in quickstart)?

Copy link
Member

Choose a reason for hiding this comment

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

Also we should check pdf still works okay.

@jlnav jlnav merged commit 0fed585 into develop May 17, 2023
13 of 14 checks passed
@jlnav jlnav deleted the docs/README_welcome_simplify branch May 17, 2023 15:02
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.

None yet

4 participants