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 Tutorial for AttentionXML #368

Merged
merged 5 commits into from
Apr 19, 2024
Merged

Conversation

donglihe-hub
Copy link
Contributor

@donglihe-hub donglihe-hub commented Apr 9, 2024

What does this PR do?

Add tutorial for AttentionXML.

It seems that I have no rights to modify the bibliography.

Test CLI & API (bash tests/autotest.sh)

Test APIs used by main.py.

  • Test Pass
    • (Copy and paste the last outputted line here.)
  • Not Applicable (i.e., the PR does not include API changes.)

Check API Document

If any new APIs are added, please check if the description of the APIs is added to API document.

  • API document is updated (linear, nn)
  • Not Applicable (i.e., the PR does not include API changes.)

Test quickstart & API (bash tests/docs/test_changed_document.sh)

If any APIs in quickstarts or tutorials are modified, please run this test to check if the current examples can run correctly after the modified APIs are released.

@Eleven1Liu Eleven1Liu added the documentation Improvements or additions to documentation label Apr 10, 2024
@donglihe-hub donglihe-hub marked this pull request as ready for review April 18, 2024 12:07
@donglihe-hub
Copy link
Contributor Author

donglihe-hub commented Apr 18, 2024

@Eleven1Liu Please review the new documentation.

Sphinx uses global reference, which means all references will be one and only one place that lists all the references (Like a bibliography). That's why you can see AttentionXML in linear "handling many labels". I suggest we move the bibliography to another file.

Copy link
Collaborator

@Eleven1Liu Eleven1Liu left a comment

Choose a reason for hiding this comment

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

LGTM

@Eleven1Liu Eleven1Liu merged commit 1c39d40 into ASUS-AICS:master Apr 19, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants