Skip to content

Commit

Permalink
Merge pull request #128 from MDIL-SNU/YutackPark-patch-1
Browse files Browse the repository at this point in the history
docs: update `sevenn_graph_build` of README.md
  • Loading branch information
YutackPark authored Nov 27, 2024
2 parents df40469 + 70a3ef0 commit 629f864
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 4 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file.
## [0.10.2]
### Added
- Accelerated graph build routine if matscipy is installed @hexagonerose
### Changed
- matscipy is included as dependency

## [0.10.1]
### Added
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,10 @@ Please note that `batch_size` in input.yaml indicates `batch_size` per GPU.
sevenn_graph_build my_train_data.extxyz 5.0
```

You can preprocess the dataset with `sevenn_graph_build` to obtain `*.sevenn_data` files. The cutoff length should be provided.
You can preprocess the dataset with `sevenn_graph_build` to obtain `./sevenn_data/graph.pt` files. These files can be used for training (`sevenn`) or
inference (`sevenn_inference`), skipping the graph build stage. `./sevenn_data/graph.yaml` contains statistics and meta information for the dataset.
These files must be located under the `sevenn_data`. If you move the dataset, move the entire `sevenn_data` directory without changing the contents.

See `sevenn_graph_build --help` for more information.

### sevenn_inference
Expand Down
7 changes: 4 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
[project]
name = "sevenn"
version = "0.10.2.dev"
version = "0.10.2"
authors = [
{ name = "Yutack Park", email = "[email protected]" },
{ name = "Haekwan Jeon", email = "[email protected]" },
{ name = "Jaesun Kim" },
{ name = "Gijin Kim" },
{ name = "Hyungmin An" },
Expand All @@ -25,10 +26,10 @@ dependencies = [
"scikit-learn",
"torch_geometric>=2.5.0",
"numpy<2.0",
#"matscipy",
"matscipy",
]
[project.optional-dependencies]
matscipy = ["matscipy"]
test = ["matscipy", "pytest-cov>=5"]


[project.scripts]
Expand Down

0 comments on commit 629f864

Please sign in to comment.