Update documentation - Githubissues

interTwin-eu / itwinai

Advanced AI workflows for digital twins applications in science.

https://itwinai.readthedocs.io

MIT License

15 stars 5 forks source link

Update documentation #164

Open matbun opened 5 months ago

matbun commented 5 months ago

[x] #159
[x] Create a README under docs/ explaining how to manage documentation
[x] organize RST files in subfolders reflecting the order of the navigation
[x] Add python script for tutorial on trainer class: https://github.com/interTwin-eu/itwinai/tree/main/tutorials/distributed-ml/torch-tutorial-2-trainer-class
[ ] Explain difference between DDP, Horovod, and DeepSpeed
[x] Embed video tutorials
[x] Add explanation on itwinai loggers
[x] Check if some MD files can be converted to RST for better integration with the RTD documentation page
[ ] Add dropdown to files added to use cases pages, to improve readability

matbun commented 4 months ago

@VerderK could you update the docs README please?

matbun commented 2 months ago

@VerderK could you update the docs README please?

I have done it... https://github.com/interTwin-eu/itwinai/pull/197

VerderK commented 2 months ago

Thank you matteo, my apologies for having left this open.

From: Matteo Bunino @.> Sent: Tuesday, September 3, 2024 9:41 AM To: interTwin-eu/itwinai @.> Cc: Killian Verder @.>; Mention @.> Subject: Re: [interTwin-eu/itwinai] Update documentation (Issue #164)

@VerderKhttps://github.com/VerderK could you update the docs README please?

I have done it...

— Reply to this email directly, view it on GitHubhttps://github.com/interTwin-eu/itwinai/issues/164#issuecomment-2325814429, or unsubscribehttps://github.com/notifications/unsubscribe-auth/BH22YZ4MOFMEU2SLNMNWAU3ZUVRZNAVCNFSM6AAAAABJT234D2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMRVHAYTINBSHE. You are receiving this because you were mentioned.Message ID: @.**@.>>

matbun commented 2 months ago

News on loggers?

VerderK commented 2 months ago

Ciao matteo, Sorry for the silence on my end. I’ve been quite ill the last few days but am recovering well. If you have time tomorrow, would you mind if I take 15 minutes of your time to run through the loggers documentation?

From: Matteo Bunino @.> Sent: 10 September 2024 16:11 To: interTwin-eu/itwinai @.> Cc: Killian Verder @.>; Mention @.> Subject: Re: [interTwin-eu/itwinai] Update documentation (Issue #164)

News on loggers?

— Reply to this email directly, view it on GitHubhttps://github.com/interTwin-eu/itwinai/issues/164#issuecomment-2340940665, or unsubscribehttps://github.com/notifications/unsubscribe-auth/BH22YZ2LQ4SAMY6HJP5GUODZV34Y3AVCNFSM6AAAAABJT234D2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNBQHE2DANRWGU. You are receiving this because you were mentioned.Message ID: @.**@.>>