Skip to content

Added code structure to README and fixed remaining torch.dist.launch #226

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

Merged
merged 2 commits into from
Feb 23, 2023

Conversation

vfdev-5
Copy link
Member

@vfdev-5 vfdev-5 commented Feb 21, 2023

Description

Added code structure to README and fixed remaining torch.dist.launch with torchrun

@netlify
Copy link

netlify bot commented Feb 21, 2023

Deploy Preview for code-generator ready!

Name Link
🔨 Latest commit 5bcd7f8
🔍 Latest deploy log https://app.netlify.com/sites/code-generator/deploys/63f54569ae3b22000856a637
😎 Deploy Preview https://deploy-preview-226--code-generator.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented Feb 21, 2023

Deploy Preview for code-generator ready!

Name Link
🔨 Latest commit 241d586
🔍 Latest deploy log https://app.netlify.com/sites/code-generator/deploys/63f54d080b52920008f5720a
😎 Deploy Preview https://deploy-preview-226--code-generator.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@vfdev-5
Copy link
Member Author

vfdev-5 commented Feb 21, 2023

@ericdatakelly I added code structure in this PR to the templates. You can check it here: https://deploy-preview-226--code-generator.netlify.app/create

It will look like along the lines:


Getting Started

Install the dependencies with pip:

pip install -r requirements.txt --progress-bar off -U

Code structure

|
|- README.md
|
|- main.py : main script to run
|- data.py : helper module with functions to setup input datasets and create dataloaders
|- models.py : helper module with functions to create a model or multiple models
|- trainers.py : helper module with functions to create trainer and evaluator
|- utils.py : module with various helper functions
|
|- requirements.txt : dependencies to install with pip
|
|- config.yaml : global configuration YAML file

Do you think whether this is enough for understanding about provided code ?
Thanks

@vfdev-5 vfdev-5 merged commit bf4a9bf into main Feb 23, 2023
@vfdev-5 vfdev-5 deleted the update-readmes branch February 23, 2023 20:17
@ericdatakelly
Copy link

@vfdev-5 Sorry, I meant to look at this sooner. I think it's helpful, but whether it's enough depends on the user. I think it's a good addition so I support the merge.

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.

2 participants