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

Small editions #4

Open
10 tasks done
bernalde opened this issue Dec 13, 2024 · 2 comments
Open
10 tasks done

Small editions #4

bernalde opened this issue Dec 13, 2024 · 2 comments

Comments

@bernalde
Copy link
Member

bernalde commented Dec 13, 2024

Ben, this is looking great.
A few comments which I would like you to address based on my going through the HTML book.

  • Remove PSR, NASA, and USRA affiliations from the notebooks
  • Add some introduction to the landing page of the Book
  • QUBO Notebook: The first example in the QUBO notebook is rendering wrongly (I believe is a double $$ issue)
  • QUBO Notebook: the problem statement is rendering within a equation (open $)
  • QUBO Notebook: The first plot_energies plot has a lot of tags in the x-axis. There is an argument in that function to make it prettier.
  • GAMA: Rendering of the text after Example 4 (open $)
  • QA: Rendering of the text after problem statement (open $). Same happens in the QUBO refomrulation.
  • Benchmarking: Rendering after the metric definition (open $)
  • Benchmarking: Change "Approximation ratio" to "performance ratio" in y-axis labels.
  • When sitting in the QA tab, the Benchmarking tab reads as "About this notebook" (I believe is by pre-generating the HTML)
@murraybj
Copy link
Collaborator

As a note: The issue with double $$ is an artifact of a regex operation when compiling the JupyterBook. The problem is currently fixed but may reappear later if the developers patch this issue. The open issue is here: jupyter-book/jupyter-book#1181

@bernalde
Copy link
Member Author

Another missing thing, can you put the button to launch the Google Colab notebooks (both here and in the other book)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants