Closed cvphelps closed 7 months ago
New dependencies detected. Learn more about Socket for GitHub ↗︎
Package | New capabilities | Transitives | Size | Publisher |
---|---|---|---|---|
pypi/pandas@2.1.2 | environment, eval, filesystem, network, shell, unsafe | +12 |
67.2 MB | MarcoGorelli, datapythonista, jbrockmendel, ...8 more |
pypi/streamlit@1.28.1 | environment, eval, filesystem, network, shell, unsafe | +1533 |
20 GB | jroes-streamlit, kmcgrady, treuille, ...1 more |
Check out this pull request on
See visual diffs & provide feedback on Jupyter Notebooks.
Powered by ReviewNB
Thanks for contributing to wandb/examples
!
We appreciate your efforts in opening a PR for the examples repository. Our goal is to ensure a smooth and enjoyable experience for you 😎.
The examples repo is regularly tested against the ever-evolving ML stack. To facilitate our work, please adhere to the following guidelines:
Notebook naming: You can use a combination of snakecase and CamelCase for your notebook name. Avoid using spaces (replace them with `) and special characters (
&%$?`). For example:
Cool_Keras_integration_example_with_weights_and_biases.ipynb
is acceptable, but
Cool Keras Example with W&B.ipynb
is not. Avoid spaces and the &
character. To refer to W&B, you can use: weights_and_biases
or just wandb
(it's our library, after all!)
Managing dependencies within the notebook: You may need to set up dependencies to ensure that your code works. Please avoid the following practices:
Dockerfile
to the wandb/examples/examples
folder (where non-Colab examples reside).pip install
as the primary method to install packages. When calling pip
in a cell, avoid performing other tasks. We automatically filter these types of cells, and executing other actions might break the automatic testing of the notebooks. For example,
pip install -qU wandb transformers gpt4
is acceptable, but
pip install -qU wandb
import wandb
is not.
GitHub
, did you know that you can install them like this:!pip install -q git+https://github.com/huggingface/transformers
You don't need to clone, then
cd
into the repo and install it in editable mode.
/content
directory where everything resides. Avoid explicitly referencing this directory because we test our notebooks with pure Jupyter (without Colab). Instead, use relative paths to make the notebook reproducible.The Jupyter notebook file .ipynb
is nothing more than a JSON file with primarily two types of cells: markdown and code. There is also a bunch of other metadata specific to Google Colab. We have a set of tools to ensure proper notebook formatting. These tools can be found at wandb/nb_helpers.
Before merging, wait for a maintainer to
clean
and format the notebooks you're adding. You can tag @tcapelle.
The following colabs were changed -examples/streamlit/annotation/Annotation_Streamlit_WB.ipynb
Update the
streamlit
section to have aquickstart
and anannotation
example in their own subdirectories