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.

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

add a doc page on models #112

Merged
merged 27 commits into from
Oct 15, 2023
Merged

add a doc page on models #112

merged 27 commits into from
Oct 15, 2023

Conversation

yiweny
Copy link
Contributor

@yiweny yiweny commented Oct 12, 2023

No description provided.

@weihua916
Copy link
Contributor

Thanks! Maybe somewhere we need to clarify that models take TensorFrame as input and outputs embeddings for each row.

@github-actions github-actions bot added the nn label Oct 12, 2023
@@ -81,7 +81,7 @@ def forward(self, tf: TensorFrame) -> Tensor:
x (Tensor): Input :obj:`TensorFrame` object.

Returns:
out (Tensor): Output. The shape is [batch_size, out_channels].
Tensor: Output. The shape is [batch_size, out_channels].
Copy link
Contributor

Choose a reason for hiding this comment

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

If we were to do this, then we should do this across all the places.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ohh I am just experimenting the syntax.
The return arguments look really weird in the documentation.

I think changing the syntax to above would resolve. I am going to do that for everything.

@github-actions github-actions bot added the data label Oct 13, 2023
@yiweny yiweny merged commit 76cfa75 into master Oct 15, 2023
3 checks passed
@yiweny yiweny deleted the yyuan/add-modular-documentation branch October 15, 2023 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants