SmartRedis Integration Guide

[ashao]

Based on feedback from users, the SmartRedis documentation needed
a guide for application developers to integrate into an existing
application. A new page to the documentation has been added to describe
the common tasks that typically need to be done. Basic code in each of the
four languages (C/C++/Python/Fortran) are included for the general
guidelines with a full Fortran-specific example.

Some small cleanup was also done in other areas of the documentation.

[codecov-commenter]

Codecov Report

Merging #214 (5d64b9e) into develop (9845fb3) will decrease coverage by 0.06%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop     #214      +/-   ##
===========================================
- Coverage    84.23%   84.17%   -0.07%     
===========================================
  Files           59       59              
  Lines         3312     3312              
===========================================
- Hits          2790     2788       -2     
- Misses         522      524       +2     

Impacted Files	Coverage Δ
smartsim/_core/launcher/taskManager.py	79.88% <0.00%> (-1.19%)	⬇️

[billschereriii]

Let's make a decision about database vs Orchestrator vs "backend database" and use it consistently, globally.

[billschereriii]

Do we still reference keys in the API anywhere? I think we got rid of all instances, but they may still be present in variable names for Fortran. Might be a bit confusing if we're not careful here

[ashao]

True. I do see it in various aspects of the documentation, but I do think name is better than key

[juliaputko]

Change to: "Now when this program runs, at every time step, the client will be used to send the
temperature array to the database, "
slightly unclear

[ashao]

Reworded to:

This model will now use the client every timestep to put a
temperature array in the orchestrator, instruct the orchestrator to call
a machine learning model for prediction/inference, and unpack the resulting
inference into the existing temperature array.

[billschereriii]

That's a buffer overflow -- you forgot about the null terminator. Declare the prefix as length 64 or 256

[ashao]

Nice catch, added it.

[juliaputko]

Grammar edits

[billschereriii]

Is rank_id really a pointer? If so, this is correct and the C example below (which treats it as a value) is wrong. If not, dereferencing a non-pointer will fail to compile

[ashao]

Yes it is a pointer in most MPI applications since MPI almost deals exclusively with memory addresses

[billschereriii]

ranks required => each rank requires a different

Can comment that MPI rank 0 is a good candidate for setting up models

[ashao]

Good call

[billschereriii]

Would the typical reader be more comfortable with C++ than Fortran?

[ashao]

We've been fielding more queries from the Fortran dev community than the C++ one. We can always include more examples later on down the line, but for a first pass I wanted to keep it in one language.

[billschereriii]

To confirm, I6.6 will format an integer into exactly 6 digits? What happens if someone runs this with rank 1,000,000? Will it get formatted as 7 digits and overflow the buffer?

[ashao]

Yes, so for those extreme cases, they should definitely increase the width. Fortran I think typically truncates the number so in this case you would end up with ~100k namespace clashes.

[billschereriii]

Call out that we don't need to prefix the model key?

[ashao]

Good suggestion

[billschereriii]

Can you explain why you deleted this stuff?

[ashao]

It was an empty cell

[billschereriii]

I have no idea what changed here. The line is insanely long with all the image data. Please make sure the image still loads and renders properly before merging.

[ashao]

Yah not sure why this happened, but it looks ok

[billschereriii]

See next comment

[ashao]

Can we comment on the comment?

[billschereriii]

See the comment that would have been the previous comment if this and the previous comment were in the reverse order

[ashao]

Random walk through comments!

[billschereriii]

Very nice PR. A few minor comments, questions, and changes and we'll be good to go

[billschereriii]

parameter -- indicated

[billschereriii]

space between comma and temperature

[billschereriii]

Looks great! Two very minor comments to resolve, but I don't need to review again