Update daas_guide.md#294
Conversation
Updated the structure and added needed user support email links as well as a link to our new data catalog. Deleted information that was outdated.
|
I'll have a look at this on Friday or early next week. |
marlon-tobaben
left a comment
There was a problem hiding this comment.
I think this looks much better than the previous version, but I still have some suggestions and requested changes.
I directly committed some changes to your branch:
- fixed formatting problem with the bullet list under "other useful information"
- changed all links within LUMI docs to be relative instead of absolute links so that we get a notification if they are broken
- moved all links to variables at the top so that they can be changed in one place even if used throughout the guide.
I have some suggestions / requested changes (see also the comments in the md file itself, but I'll list all of them here as well). Please let me know what you think, preferably by replying here in GitHub.
- https://lumi-aif.fairadata.fi does not work, please double-check the link.
- https://www.fairdata.fi/qvaimen-kayttoopas/ is Finnish, can we use https://www.fairdata.fi/en/qvain-user-guide/ instead?
- Embed the MVP note in an info box similar to https://docs.lumi-supercomputer.eu/laif/software/ai-environment/#examples-for-using-the-container-images (I can do that if you think that is a good idea)
- move the For startups and SME's, the easiest way to get started in using LUMI is by using one of [the computing packages of LUMI AI Factory][LAIF computing packages] line up to where access is first mentioned
- Rewrite "Accessing LUMI and using Datasets with HPC tools"
- DaaS is not usable without access to LUMI so it is not important to repeat access modes here, instead move "For startups and SME's, the easiest way to get started in using LUMI is by using one of [the computing packages of LUMI AI Factory][LAIF computing packages]. to the top of the page.
- I would just link to https://docs.lumi-supercomputer.eu/software/ here (users can find the other links from there) and then mention https://docs.lumi-supercomputer.eu/laif/software/ai-environment/ and https://docs.lumi-supercomputer.eu/laif/software/workflows/ as they are particularly relevant for AI users on LUMI.
- Remove "to LUMI AI Factory Dataset as a Service" from a couple of headings in the second part of the guide as it is clear from the context that DaaS is meant here.
| LUMI AIF DaaS is currently a Minimum Viable Product (MVP). MVP is the | ||
| simplest version of a product that includes only the core features necessary | ||
| to deliver value to early users and validate the product concept. The goal of | ||
| an MVP is to test assumptions quickly and with minimal resources, to gather | ||
| user feedback, and to use that feedback to guide further development. | ||
| to deliver value to early users and validate the product concept. LUMI AIF DaaS is built upon existing services and as such the user experience and available features are already quite advanced for an MVP. |
There was a problem hiding this comment.
Suggestion: Embed this in a info box similar to https://docs.lumi-supercomputer.eu/laif/software/ai-environment/#examples-for-using-the-container-images?
|
|
||
| LUMI's [data storage options are detailed in the user guide][data storage]. | ||
|
|
||
| ## Sharing your dataset to LUMI AI Factory Dataset as a Service |
There was a problem hiding this comment.
| ## Sharing your dataset to LUMI AI Factory Dataset as a Service | |
| ## Sharing your dataset |
Remove "to LUMI AI Factory Dataset as a Service" here as it is clear from context.
| The Dataset-as-a-Service (DaaS) datasets can be accessed and utilized | ||
| free-of-charge, but to access the LUMI supercomputer and to run jobs with LUMI | ||
| The LUMI AI Factory Dataset as a Service datasets can be accessed and utilized | ||
| free-of-charge. To access the LUMI supercomputer and to run jobs with LUMI | ||
| using the DaaS datasets, you need to be a member of a project that has been | ||
| granted resources on LUMI. |
There was a problem hiding this comment.
| granted resources on LUMI. | |
| granted resources on LUMI. For startups and SME's, the easiest way to get started in using LUMI is by using one of [the computing packages of LUMI AI Factory][LAIF computing packages]. |
Move this here from below.
|
|
||
| LUMI's [data storage options are detailed in the user guide][data storage]. | ||
|
|
||
| ## Sharing your dataset to LUMI AI Factory Dataset as a Service |
There was a problem hiding this comment.
| ## Sharing your dataset to LUMI AI Factory Dataset as a Service | |
| ## Sharing your dataset |
Clear from context that this is DaaS
|
|
||
| LUMI AIF DaaS is not a repository or a preservation service. It does not take away your ownership of data or remove your right to manage access to it. LUMI AIF DaaS facilitates access and findability. Publish your data to increase its impact, discover new use cases, meet compliance requirements, attract collaborators and customers, and participate in cutting‑edge scientific and industrial innovation. | ||
|
|
||
| ### What is required of a dataset in LUMI AI Factory Dataset as a Service |
There was a problem hiding this comment.
| ### What is required of a dataset in LUMI AI Factory Dataset as a Service | |
| ### What is required of a dataset |
Clear from context that this is DaaS
| ### Accessing LUMI and using Datasets with HPC Tools | ||
|
|
||
| To be able to use the HPC tools on LUMI, you need to be a member of a project | ||
| that has been granted resources on LUMI. The LUMI consortium countries have | ||
| different policies for accessing LUMI. An overview of the access policies is | ||
| provided on the | ||
| [LUMI Supercomputer Get Started](https://lumi-supercomputer.eu/get-started/) | ||
| page. | ||
| [LUMI Supercomputer Get Started][get started] | ||
| page. For startups and SME's, the easiest way to get started in using LUMI is by using one of [the computing packages of LUMI AI Factory][LAIF computing packages]. | ||
|
|
||
| You can use pre-installed software on LUMI, install additional software | ||
| yourself or use an Apptainer/Singularity container or the LUMI container | ||
| wrapper: | ||
| [https://docs.lumi-supercomputer.eu/software/](https://docs.lumi-supercomputer.eu/software/). | ||
| wrapper [as detailed in LUMI user guide][software]. | ||
|
|
||
| Software library: | ||
| [https://lumi-supercomputer.github.io/LUMI-EasyBuild-docs/](https://lumi-supercomputer.github.io/LUMI-EasyBuild-docs/) | ||
| Other useful documentation: | ||
|
|
||
| Containerized Workflows are developed by the LUMI AI Factory to streamline AI | ||
| related tasks in HPC environment: | ||
| [https://docs.lumi-supercomputer.eu/software/local/lumi-aif/#containerized-workflows](https://docs.lumi-supercomputer.eu/software/local/lumi-aif/#containerized-workflows) | ||
| - [Software library][Software library] | ||
|
|
||
| Running jobs on LUMI: | ||
| [https://docs.lumi-supercomputer.eu/runjobs/](https://docs.lumi-supercomputer.eu/runjobs/) | ||
| - [Containerized Workflows][containerized workflows] are developed by the LUMI AI Factory to streamline AI | ||
| related tasks in HPC environment | ||
|
|
||
| ## Citation | ||
| - [AI software environment][AI software environment] | ||
|
|
||
| - [Running jobs on LUMI][run jobs] |
There was a problem hiding this comment.
I suggest rewriting this a bit:
- DaaS is not usable without access to LUMI so it is not important to repeat access modes here, instead move "For startups and SME's, the easiest way to get started in using LUMI is by using one of [the computing packages of LUMI AI Factory][LAIF computing packages]. to the top of the page.
- I would just link to https://docs.lumi-supercomputer.eu/software/ here (users can find the other links from there) and then mention https://docs.lumi-supercomputer.eu/laif/software/ai-environment/ and https://docs.lumi-supercomputer.eu/laif/software/workflows/ as they are particularly relevant for AI users on LUMI.
| ### Accessing LUMI and using Datasets with HPC Tools | |
| To be able to use the HPC tools on LUMI, you need to be a member of a project | |
| that has been granted resources on LUMI. The LUMI consortium countries have | |
| different policies for accessing LUMI. An overview of the access policies is | |
| provided on the | |
| [LUMI Supercomputer Get Started](https://lumi-supercomputer.eu/get-started/) | |
| page. | |
| [LUMI Supercomputer Get Started][get started] | |
| page. For startups and SME's, the easiest way to get started in using LUMI is by using one of [the computing packages of LUMI AI Factory][LAIF computing packages]. | |
| You can use pre-installed software on LUMI, install additional software | |
| yourself or use an Apptainer/Singularity container or the LUMI container | |
| wrapper: | |
| [https://docs.lumi-supercomputer.eu/software/](https://docs.lumi-supercomputer.eu/software/). | |
| wrapper [as detailed in LUMI user guide][software]. | |
| Software library: | |
| [https://lumi-supercomputer.github.io/LUMI-EasyBuild-docs/](https://lumi-supercomputer.github.io/LUMI-EasyBuild-docs/) | |
| Other useful documentation: | |
| Containerized Workflows are developed by the LUMI AI Factory to streamline AI | |
| related tasks in HPC environment: | |
| [https://docs.lumi-supercomputer.eu/software/local/lumi-aif/#containerized-workflows](https://docs.lumi-supercomputer.eu/software/local/lumi-aif/#containerized-workflows) | |
| - [Software library][Software library] | |
| Running jobs on LUMI: | |
| [https://docs.lumi-supercomputer.eu/runjobs/](https://docs.lumi-supercomputer.eu/runjobs/) | |
| - [Containerized Workflows][containerized workflows] are developed by the LUMI AI Factory to streamline AI | |
| related tasks in HPC environment | |
| ## Citation | |
| - [AI software environment][AI software environment] | |
| - [Running jobs on LUMI][run jobs] | |
| ### Using datasets on LUMI | |
| LUMI docs provides general information on [software on LUMI][software] and [running jobs on LUMI][run jobs]. The [AI software environment][AI software environment] and [Containerized Workflows][containerized workflows] developed by LUMI AI Factory could be especially relevant to AI users on LUMI. |
| [access LUMI]: ./../../firststeps/accessLUMI.md | ||
| [AI software environment]: ./../../laif/software/ai-environment.md | ||
| [containerized workflows]: ./../software/workflows.md | ||
| [data catalogue]: https://lumi-aif.fairadata.fi |
There was a problem hiding this comment.
The data catalogue link doesn't work, please double check.
| [containerized workflows]: ./../software/workflows.md | ||
| [data catalogue]: https://lumi-aif.fairadata.fi | ||
| [data storage]: ./../../storage/index.md | ||
| [fairdata guide for adding dataset metadata]: https://www.fairdata.fi/qvaimen-kayttoopas/ |
There was a problem hiding this comment.
Can we use English link? https://www.fairdata.fi/en/qvain-user-guide/
Replace underscore with hyphen in names of DaaS files to conform to site style.
|
Committed 9ea49df to fix a previous oversight on my part. |
Updated the structure and added needed user support email links as well as a link to our new data catalog. Deleted information that was outdated.