Skip to content

Commit

Permalink
Changed name to bs-scheduler
Browse files Browse the repository at this point in the history
  • Loading branch information
ancestor-mithril committed Sep 3, 2024
1 parent 4e2bb0c commit fc2f9ee
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# bs_scheduler
# bs-scheduler

A Batch Size Scheduler library compatible with PyTorch DataLoaders.

***

Documentation: [API Reference](https://ancestor-mithril.github.io/bs_scheduler/).
Documentation: [API Reference](https://ancestor-mithril.github.io/bs-scheduler/).

<!--Examples: TODO. -->

Expand Down Expand Up @@ -60,7 +60,7 @@ pip install bs-scheduler
Or from git:

```
pip install git+https://github.com/ancestor-mithril/bs_scheduler.git@master
pip install git+https://github.com/ancestor-mithril/bs-scheduler.git@master
```

## Licensing
Expand Down
2 changes: 1 addition & 1 deletion bs_scheduler/batch_size_schedulers.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ def __init__(self, dataloader: DataLoader, batch_size_manager: Union[BatchSizeMa
check_isinstance(dataloader, DataLoader)
except TypeError:
print("Parameter dataloader is not a DataLoader. If you really need this feature, please open an issue at "
"https://github.com/ancestor-mithril/bs_scheduler/issues and describe your use case.")
"https://github.com/ancestor-mithril/bs-scheduler/issues and describe your use case.")
raise
self.dataloader: DataLoader = dataloader
self.verbose: bool = verbose
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
::: bs_scheduler
::: bs-scheduler
8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[project]
name = "bs_scheduler"
name = "bs-scheduler"
version = "0.4.2"
requires-python = ">=3.9"
description = "A PyTorch Dataloader compatible batch size scheduler library."
Expand Down Expand Up @@ -30,11 +30,11 @@ dependencies = [
"torch>=1.1.0",
]
[tool.setuptools.packages.find]
include = ["bs_scheduler"]
include = ["bs-scheduler"]

[project.urls]
Repository = "https://github.com/ancestor-mithril/bs_scheduler"
Issues = "https://github.com/ancestor-mithril/bs_scheduler/issues"
Repository = "https://github.com/ancestor-mithril/bs-scheduler"
Issues = "https://github.com/ancestor-mithril/bs-scheduler/issues"


[project.optional-dependencies]
Expand Down

0 comments on commit fc2f9ee

Please sign in to comment.