Skip to content

feat: Add advanced quickstart example #5

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

Merged
merged 41 commits into from
Apr 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
d254df5
feat: Add advanced quickstart example
LeoRoccoBreedt Feb 25, 2025
c147321
refactor: Remove screenshots from notebook
LeoRoccoBreedt Feb 26, 2025
abe2b44
refactor: Update API token input and workspace name placeholders
LeoRoccoBreedt Feb 26, 2025
d157a14
refactor: Update the random logic for each metric
LeoRoccoBreedt Feb 26, 2025
ddde7df
surface fixups
normandy7 Mar 5, 2025
962a64a
fix JSON
normandy7 Mar 5, 2025
35c2c54
more fixups
normandy7 Mar 5, 2025
9218434
tweak project setup
normandy7 Mar 5, 2025
5229723
remove outputs
normandy7 Mar 5, 2025
680f82b
typo
normandy7 Mar 5, 2025
8e932ea
fix: google colab link and example heading
LeoRoccoBreedt Mar 7, 2025
885e340
fix: section details and clarify some points
LeoRoccoBreedt Mar 7, 2025
c6ab6df
Merge branch 'main' into lb/advanced_quickstart
LeoRoccoBreedt Mar 7, 2025
79df1e9
Update test-notebooks.yml
LeoRoccoBreedt Mar 7, 2025
abb2a87
chore: add numpy to packages for failing tests
LeoRoccoBreedt Mar 7, 2025
c30cf19
style: update introduction
LeoRoccoBreedt Mar 12, 2025
c4959d2
style: update adding the environment variables
LeoRoccoBreedt Mar 12, 2025
7b95ba3
refactor: accept changes from pre-commit
LeoRoccoBreedt Mar 12, 2025
1bb85cd
feat: add quickstart script to run example
LeoRoccoBreedt Mar 12, 2025
fea7433
refactor: accept changes from pre-commit
LeoRoccoBreedt Mar 12, 2025
d187624
chore: add scripts to run test during workflow
LeoRoccoBreedt Mar 12, 2025
f822a35
chore: update folder location of quickstart notebook
LeoRoccoBreedt Mar 12, 2025
c31ad0b
chore: update notebook path for tests
LeoRoccoBreedt Mar 12, 2025
c54c350
chore: rename folder
LeoRoccoBreedt Mar 26, 2025
e1b0376
refactor: use experiment_name as main run identifier
LeoRoccoBreedt Mar 26, 2025
2eae1f8
chore: update workflow scripts
LeoRoccoBreedt Mar 26, 2025
3902207
chore: pre-commit updates
LeoRoccoBreedt Mar 26, 2025
1ba6166
Merge branch 'main' into lb/advanced_quickstart
SiddhantSadangi Apr 8, 2025
aa7e514
feat: updated quickstart
SiddhantSadangi Apr 9, 2025
93a7d37
feat: added link to charts tab
SiddhantSadangi Apr 9, 2025
4715940
chore: removed unecessary param
SiddhantSadangi Apr 9, 2025
3163a88
Update how-to-guides/quickstart/notebooks/neptune_scale_quickstart.ipynb
LeoRoccoBreedt Apr 16, 2025
c037312
Update how-to-guides/quickstart/notebooks/neptune_scale_quickstart.ipynb
LeoRoccoBreedt Apr 16, 2025
188357b
Apply suggestions from code review
LeoRoccoBreedt Apr 16, 2025
179ba3a
Merge commit '4a4853023df59539c5db19f40d104ddc98ff3ce9' into lb/advan…
LeoRoccoBreedt Apr 16, 2025
f914d60
chore: update readme with quickstart notebook
LeoRoccoBreedt Apr 16, 2025
97490bc
chore: update readme
LeoRoccoBreedt Apr 16, 2025
1fd71e2
fix: refence to notebooks
LeoRoccoBreedt Apr 16, 2025
9021fc3
chore: update names and remove scale
LeoRoccoBreedt Apr 16, 2025
e8184d8
chore: remove reference to scale
LeoRoccoBreedt Apr 16, 2025
ad1a6c0
remove unneeded separate table
normandy7 Apr 16, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/test-notebooks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ jobs:
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
notebooks: # Add in alphabetical order
- how-to-guides/hpo/notebooks/Neptune_HPO.ipynb
- how-to-guides/quickstart/notebooks/neptune_quickstart.ipynb
os: ["${{ inputs.os }}"]
steps:
- uses: actions/checkout@main
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/test-scripts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ jobs:
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
scripts: # Add in alphabetical order
- how-to-guides/hpo/scripts
- how-to-guides/quickstart/scripts
os: ["${{ inputs.os }}"]
steps:
- uses: actions/checkout@main
Expand Down
6 changes: 3 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@ repos:
- id: trailing-whitespace
args: [--markdown-linebreak-ext=md]
- repo: https://github.com/kynan/nbstripout
rev: 0.8.0
rev: 0.8.1
hooks:
- id: nbstripout
args:
- --drop-empty-cells --extra-keys "cell.metadata.colab cell.metadata.id cell.metadata.outputId cell.metadata.pycharm metadata.kernelspec metadata.vscode"
- repo: https://github.com/pycqa/isort
rev: 5.13.2
rev: 6.0.1
hooks:
- id: isort
args: ["--profile", "black"]
- repo: https://github.com/psf/black
rev: 24.10.0
rev: 25.1.0
hooks:
- id: black
args:
Expand Down
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,9 @@ With Neptune, you can monitor thousands of per-layer metrics—losses, gradients

This repo contains tutorials and examples of how to use Neptune.

### First steps

| | Docs | Neptune |
| ------------------------ | ---------------------------- | --------------------------------------- |
| Quickstart | [![docs-icon]][quickstart] | |
| Analyze runs | [![docs-icon]][analyze-runs] | [![neptune-icon]][analyze-runs-example] |

### How-to guides

| | Docs | Neptune | GitHub | Colab |
| ------------------------------- | ---------------------------- | --------------------------------------- | ------------------------------ | -------------------------- |
| Quickstart | [![docs-icon]][quickstart] | [![neptune-icon]][quickstart-example] | [![github-icon]][qs-notebook] | [![colab-icon]][qs-colab] |
| Log different types of metadata | [![docs-icon]][log-metadata] | [![neptune-icon]][log-metadata-example] | | |
| Organize and filter runs | [![docs-icon]][runs-table] | [![neptune-icon]][runs-table-example] | | |
| Resume run or other object | [![docs-icon]][resume-run] | | | |
Expand All @@ -48,19 +40,20 @@ This repo contains tutorials and examples of how to use Neptune.
[from-wandb-code]: utils/migration_tools/from_wandb/
[hpo-notebook]: how-to-guides/hpo/notebooks/Neptune_HPO.ipynb
[hpo-colab]: https://colab.research.google.com/github/neptune-ai/scale-examples/blob/master/how-to-guides/hpo/notebooks/Neptune_HPO.ipynb
[qs-notebook]: how-to-guides/quickstart/notebooks/neptune_quickstart.ipynb
[qs-colab]: https://colab.research.google.com/github/neptune-ai/scale-examples/blob/master/how-to-guides/quickstart/notebooks/neptune_quickstart.ipynb

<!-- External -->
[blog]: https://neptune.ai/blog
[docs]: https://docs.neptune.ai/
[analyze-runs]: https://docs.neptune.ai/analyze_runs
[analyze-runs-example]: https://scale.neptune.ai/o/examples/org/LLM-Pretraining/runs/compare?viewId=standard-view&detailsTab=dashboard&dash=dashboard&dashboardId=9e745b6c-2c98-4e23-abbc-9b56d8123fb8&type=run&compare=auto-3
[from-legacy]: https://docs.neptune.ai/migration_neptune
[from-wandb]: https://docs.neptune.ai/migration_wandb
[hpo]: https://docs.neptune.ai/hpo_tutorial
[hpo-example]: https://scale.neptune.ai/o/examples/org/hpo/runs/table?viewId=9d44261f-32a1-42e7-96ff-9b35edc4be66
[log-metadata]: https://docs.neptune.ai/log_metadata
[log-metadata-example]: https://scale.neptune.ai/o/examples/org/LLM-Pretraining/runs/details?viewId=9e6a41f4-69a5-4d9f-951c-b1304f2acf12&detailsTab=dashboard&dashboardId=9e6a5c4c-0c39-491f-9811-87eeb39a2603&runIdentificationKey=LLM-29&type=run&compare=uMlyIDUTmecveIHVma0eEB95Ei5xu8F_9qHOh0nynbtM
[quickstart]: https://docs.neptune.ai/quickstart
[quickstart-example]: https://scale.neptune.ai/examples/quickstart/reports/9ea26258-2aed-4441-9b58-bab619215f6f
[resume-run]: https://docs.neptune.ai/resume_run
[runs-table]: https://docs.neptune.ai/runs_table
[runs-table-example]: https://scale.neptune.ai/o/examples/org/LLM-Pretraining/runs/table?viewId=9e746462-f045-4ff2-9ac4-e41fa349b04d&detailsTab=dashboard&dash=table&type=run&compare=auto-5
Expand Down
Loading