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.

Sign up for GitHub

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

Jump to bottom

Add docstring to facilitate doc generation for dockerize subcommand #1136

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add docstring to facilitate doc generation for dockerize subcommand #1136

wants to merge 1 commit into from

Conversation

ishaileshpant
Copy link
Collaborator

No description provided.

@ishaileshpant ishaileshpant marked this pull request as draft November 11, 2024 16:48
@ishaileshpant ishaileshpant marked this pull request as ready for review November 11, 2024 17:20
@ishaileshpant ishaileshpant changed the title [WIP] Add docstring to facilitate doc generation for dockerize subcommand Add docstring to facilitate doc generation for dockerize subcommand Nov 11, 2024
MasterSkepticista
MasterSkepticista reviewed Nov 12, 2024
View reviewed changes
openfl/interface/workspace.py Outdated
To package the workspace and save the Docker image as a tarball:

```python
dockerize_(context, save=True, rebuild=False, revision='main')
Copy link
Collaborator

Choose a reason for hiding this comment

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

Users won't be calling the python functions, so I suggest providing command examples.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've removed the python example altogether till we figure out best way to document all the workspace (or any such command wrapper) that is used with openfl binary wdyt @MasterSkepticista ?

@MasterSkepticista
Copy link
Collaborator

@ishaileshpant With #1140 merged, this readme provides (incomplete) details on how to use dockerize subcommand. I am open to ideas on how (and where) to best document practices on how to run an enclave-enabled container.

@ishaileshpant
Copy link
Collaborator Author

@ishaileshpant With #1140 merged, this readme provides (incomplete) details on how to use dockerize subcommand. I am open to ideas on how (and where) to best document practices on how to run an enclave-enabled container.

May be first thing is to fix this readme or link a doc specifically detailing enclave based run possibly here https://github.com/securefederatedai/openfl/tree/develop/docs/developer_guide/advanced_topics - wdyt @MasterSkepticista ?

@ishaileshpant ishaileshpant force-pushed the add-docstring-dockerize branch 4 times, most recently from f9b156b to 3ba1f82 Compare November 18, 2024 07:39
@ishaileshpant ishaileshpant force-pushed the add-docstring-dockerize branch 8 times, most recently from d87a885 to 38a1307 Compare November 19, 2024 12:53
@ishaileshpant
- Add docstring to facilitate doc generation for `fx workspace docker…
9ae28e7 
…ize` command

- Rebased - 18/Nov/2024
- Updated as per latest code and comments
- Added module level comment
Signed-off-by: Shailesh Pant <shailesh.pant@intel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MasterSkepticista MasterSkepticista Awaiting requested review from MasterSkepticista

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ishaileshpant @MasterSkepticista