Skip to content
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

creating an example of functionality in the README>=.md #140

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,19 @@ pip install -U 'git+https://github.com/facebookresearch/fvcore'
git clone https://github.com/facebookresearch/fvcore
pip install -e fvcore
```
## Example of usage
Some utilites provided by the fvcore repository is the ability to write and read in JSON.
```
from fvcore.common.file_io import PathManager

data = {"key": "value"}

# Write to a JSON file
PathManager.write_json("data.json", data)

# Read from a JSON file
loaded_data = PathManager.read_json("data.json")
```

## License

Expand Down