Utilizing Notebooks

The main purpose of NBGallery is to provide a repository of notebooks to be utilized by users for various purposes in the data science community. The basic features and how tos are essential to use NBGallery to its full potential. Viewing the notebooks in NBGallery is as simple as hitting the button labeled notebooks, and to find more nuanced selections (user notebooks, all groups, all laguages, all tags, and your groups) hit the dropdown arrow to the right of the button.


Uploading a Notebook

Uploading a notebook is easy and allows the use of tags to help users find the notebooks that will help the most.

  1. Press the upload button on top right of the screen, and upload your notebook from your desktop.
  2. From here, press next and various fields will populate.
    • Notebook ID: The unique Notebook Identifier (this cannot be altered/changed)
    • Title: The title of the notebook. (this can be different from file name)
    • Description: Each notebook is required to have a description to help user understand the use of the notebook and the particular how tos of the specific notebook.
    • Ownership: Ownership by default is granted to the uploader, but can also be granted to a certain group and another user entirely (this can be changed later if needed).
    • Tags: Tags, while not required, do help users, at a quick glance, add context to what a notebook contains and decide if your notebook may be of use to them.
    • Visibility: You can make your notebook visible to only yourself or the public.
  3. Once all required fields are filled in press upload, and it will lead you directly to your notebook on page and success notification.

The Notebook Page

Everything you need to know about any particular notebook can be found on the page of the notebook itself.

There are options and features for each notebook as an owner/group member of notebook and any nbgallery user.

The various items are pretty self-explanatory, including basic notebook information such as the title, owner (and creator if applicable) description, tags, main language of the notebook, star and view count, and current health status of the notebook.

The tool bar seen to the right side under the "Run in Jupyter" button allows for useful functions.

  • Star: Star is the equivalent of a like on NBGallery. You are able to view an notebooks you have starred as an NBGallery user.
  • Subscribe: Subscribing to a particular notebook gives you the option to receive update notification on particular notebooks (maybe ones you utilize a lot)
  • Download: Download the notebook using this option.
  • Feedback: Allows you to send direct feedback of improvments that could be made or well done elements of a notebook to the owner or group.
  • Comments: Allows you to comment on a particular notebook (a question, general advice, or just a compliment if you like).
  • Settings: Dropdown includes more options for a particular notebook (some only available, if you own the notebook or not).
    • View Notebook Metrics: This leads you to an abundance of notebook information about the notebook including runs, user views (and total views), edit history, number of stars, and other metrics.
    • View Revision History: This leads you to the changes to notebook and notices about changes (creation, deprecation, and general edits along with whomever took those actions)
    • E-mail notebook: Email notebook to someone (not necessarily an NBGallery User)
    • Propose Change Request: This is a formal request to change something in the notebook (by your own hand). This requires owner/group approval before changes are applied.
    • Get Notebook UUID: Displays the UUID of the notebook
    • Owner Actions:
      • View historical feedback: View the feedback given from users
      • Make private/public: Make a notebook private
      • Change ownership: Change the ownership to another user or group
      • Share notebook with individuals: Share your notebook with individuals (cannot share private will not be viewable)
      • Upload new version: Update the contents of the notebook by uploading the latest version.
      • Delete notebook: Delete a notebook (this action cannot be undone!)
      • Deprecate Notebook: Deprecate a notebook. This option is similar to deleting except the notebook will stay a part of NBGallery (you can choose to allow users to run the notebook or not). The contents of a deprecated notebook may be outdated or have other deprecated elements (this deprecation can be reversed)

Searching Notebooks

What good is having a collection of notebooks if we cannot filter through them to find only the most critical/useful one. Searching is made easy and seamless in NBGallery.

The easiest way is via the homepage. Your searches can be filtered with various fields and sorted via a number of fields as well.

For more information on advanced/filtered search: Click Me!