-
Notifications
You must be signed in to change notification settings - Fork 53
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
Documentation #71
base: main
Are you sure you want to change the base?
Documentation #71
Conversation
Co-authored-by: Chenghao Liu <74166079+chenghaoliu89@users.noreply.github.com>
Are we good to merge this? We can create a new one when we have more documentation? |
Hello, I'm sorry to bother you. When reading the code, I think the following parts may be relatively difficult to understand, and it is possible to add some comments in the code or additional documentation to further enhance the understanding of the project.
Thank you again for your great work, and hope that you can find these suggestions/information useful! |
@gorold could you add clarification for |
better to add code comment about batch, packed_batch, merged_batch in line 109-116 from loader.py, and show their format, shape, the label of padding used for bin_package etc. |
You can see the typehints for format and shape of arrays and tensors, but yeah, I'll add the docstrings for loader.py |
@@ -141,6 +161,14 @@ def first_fit_decreasing_bin_packing( | |||
def get_sample_id( | |||
self, batch: list[list[Sample]], bin_spaces: Int[np.ndarray, "batch"] | |||
) -> Int[torch.Tensor, "batch seq"]: | |||
""" | |||
Create an array of integers representing the sample id in a sequence. | |||
Sample id starts from 1, and 0 represents padding. |
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.
This is very helpful, could you also explain the what it means when the variate_id, time_id value is 1 or 0 in transform?
This branch/PR compiles the efforts to enhance the documentation of the uni2ts library.