https://github.com/lazyscribe/lazyscribe
Lightweight, lazy model experiment logging
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.2%) to scientific vocabulary
Keywords
Repository
Lightweight, lazy model experiment logging
Basic Info
- Host: GitHub
- Owner: lazyscribe
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://lazyscribe.github.io/lazyscribe/
- Size: 247 KB
Statistics
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 16
- Releases: 15
Topics
Metadata Files
README.md
Lightweight, lazy experiment logging
lazyscribe is a lightweight package for model experiment logging. It creates a single JSON
file per project, and an experiment is only added to the file when code finishes (errors won't
result in partially finished experiments in your project log).
lazyscribe also has functionality to allow for multiple people to work on a single project.
You can merge projects together and update the list of experiments to create a single, authoritative
view of all executed experiments.
Installation
Python 3.9 and above is required. Use pip to install:
console
$ python -m pip install lazyscribe
Basic Usage
The basic usage involves instantiating a Project and using the context manager to log
an experiment:
```python import json
from lazyscribe import Project
project = Project(fpath="project.json") with project.log(name="My experiment") as exp: exp.logmetric("auroc", 0.5) exp.logparameter("algorithm", "lightgbm") ```
You've created an experiment! You can view the experimental data by using list:
python
print(json.dumps(list(project), indent=4))
json
[
{
"name": "My experiment",
"author": "<AUTHOR>",
"last_updated_by": "<AUTHOR>",
"metrics": {
"auroc": 0.5
},
"parameters": {
"algorithm": "lightgbm"
},
"created_at": "<CREATED_AT>",
"last_updated": "<LAST_UPDATED>",
"dependencies": [],
"short_slug": "my-experiment",
"slug": "my-experiment-<CREATED_AT>",
"tests": [],
"artifacts": []
}
]
Once you've finished, save the project to project.json:
python
project.save()
Later on, you can read the project back in read-only mode ("r"), append mode ("a"), or editable mode ("w+"):
python
project = Project("project.json", mode="r")
with project.log(name="New experiment") as exp: # Raises a ReadOnlyError
...
Owner
- Name: lazyscribe
- Login: lazyscribe
- Kind: organization
- Repositories: 2
- Profile: https://github.com/lazyscribe
GitHub Events
Total
- Create event: 34
- Release event: 7
- Issues event: 33
- Watch event: 2
- Delete event: 25
- Issue comment event: 199
- Push event: 121
- Pull request review comment event: 136
- Pull request review event: 188
- Pull request event: 118
- Fork event: 3
Last Year
- Create event: 34
- Release event: 7
- Issues event: 33
- Watch event: 2
- Delete event: 25
- Issue comment event: 199
- Push event: 121
- Pull request review comment event: 136
- Pull request review event: 188
- Pull request event: 118
- Fork event: 3
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 15
- Total pull requests: 52
- Average time to close issues: 10 days
- Average time to close pull requests: 6 days
- Total issue authors: 3
- Total pull request authors: 5
- Average comments per issue: 0.53
- Average comments per pull request: 1.44
- Merged pull requests: 35
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 15
- Pull requests: 52
- Average time to close issues: 10 days
- Average time to close pull requests: 6 days
- Issue authors: 3
- Pull request authors: 5
- Average comments per issue: 0.53
- Average comments per pull request: 1.44
- Merged pull requests: 35
- Bot issues: 0
- Bot pull requests: 2
Top Authors
Issue Authors
- kuraga (16)
- jdawang (3)
- ak-gupta (2)
- github-actions[bot] (1)
Pull Request Authors
- kuraga (40)
- ak-gupta (27)
- jdawang (9)
- github-actions[bot] (7)
- gladysteh99 (5)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 105 last-month
- Total dependent packages: 1
- Total dependent repositories: 1
- Total versions: 14
- Total maintainers: 1
pypi.org: lazyscribe
Lightweight and lazy experiment logging
- Documentation: https://lazyscribe.readthedocs.io/
- License: MIT license
-
Latest release: 1.2.0
published 7 months ago
Rankings
Maintainers (1)
Dependencies
- attrs ==21.4.0
- python-slugify ==5.0.2
- text-unidecode ==1.3
- actions/checkout v2 composite
- fdosani/run-edgetest-action v1.0 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- codecov/codecov-action v2 composite
- attrs <=23.1.0,>=21.2.0
- fsspec <=2023.5.0,>=0.4.0
- importlib-metadata <=6.6.0,>=6.0
- python-slugify <=8.0.1,>=5.0.0
- actions/checkout v4 composite
- actions/deploy-pages v4 composite
- actions/setup-python v5 composite
- actions/upload-pages-artifact v3 composite