-
Notifications
You must be signed in to change notification settings - Fork 32
Update docs/source/layers.md with LocalFuncRepository example #211
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
base: main
Are you sure you want to change the base?
Conversation
MekkCyber
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the contribution ! just left few nits
| ### Loading from a local repository for testing | ||
|
|
||
| The `LocalLayerRepository` class is provided to load a repository from | ||
| The `LocalLayerRepository` class is provided to load a layer repository from |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can have repositories that contain layers, and functions at the same time, so there is not such thing as layer repository and function repository
|
|
||
| The parameters are: | ||
| - `repo_path`: Path to the local kernel repository directory | ||
| - `package_name`: The Python package name of the kernel | ||
| - `func_name`: The name of the function within the kernel repository |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe we don't need to add this, it's already very explicit within the example, wdyt ?
| Locked functions can also be used with `LockedFuncRepository`. This is useful for stateless | ||
| layers or functions that were converted with `use_kernel_func_from_hub`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure this is accurate since all layers are stateless, maybe we can just say
| Locked functions can also be used with `LockedFuncRepository`. This is useful for stateless | |
| layers or functions that were converted with `use_kernel_func_from_hub`: | |
| Locking is also supported for functions, just like for layers, through the use of `LockedFuncRepository`: |
I wanted to update the guides with more example of usage for
LocalFuncRepositoryandLockedFuncRepository