Skip to content

Commit

Permalink
Update readme to use github.com URLs rather than relative URLs (#74)
Browse files Browse the repository at this point in the history
On sites like PyPI we want to link people to github rather than keep them on-site.

Co-authored-by: Simon Beal <[email protected]>
  • Loading branch information
muddyfish and muddyfish authored Nov 28, 2023
1 parent 37da090 commit e1d871e
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ automatically optimizes performance when downloading training data from and writ
pip install s3torchconnector
```

Amazon S3 Connector for PyTorch supports only Linux via Pip for now. For other platforms, see [DEVELOPMENT](doc/DEVELOPMENT.md) for build instructions.
Amazon S3 Connector for PyTorch supports only Linux via Pip for now. For other platforms, see [DEVELOPMENT](https://github.com/awslabs/s3-connector-for-pytorch/blob/main/doc/DEVELOPMENT.md) for build instructions.

### Configuration

Expand All @@ -36,7 +36,7 @@ To use `s3torchconnector`, AWS credentials must be provided through one of the f
### Examples

[API docs](http://awslabs.github.io/s3-connector-for-pytorch) are showing API of the public components.
End to end example of how to use `s3torchconnector` can be found under the [examples](examples/) directory.
End to end example of how to use `s3torchconnector` can be found under the [examples](https://github.com/awslabs/s3-connector-for-pytorch/tree/main/examples) directory.

#### Sample Examples

Expand Down Expand Up @@ -93,10 +93,10 @@ model.load_state_dict(state_dict)
```
## Contributing
We welcome contributions to Amazon S3 Connector for PyTorch. Please see [CONTRIBUTING](doc/CONTRIBUTING.md) For more information on how to report bugs or submit pull requests.
We welcome contributions to Amazon S3 Connector for PyTorch. Please see [CONTRIBUTING](https://github.com/awslabs/s3-connector-for-pytorch/blob/main/doc/CONTRIBUTING.md) For more information on how to report bugs or submit pull requests.
### Development
See [DEVELOPMENT](doc/DEVELOPMENT.md) for information about code style,
See [DEVELOPMENT](https://github.com/awslabs/s3-connector-for-pytorch/blob/main/doc/DEVELOPMENT.md) for information about code style,
development process, and guidelines.
Expand All @@ -105,9 +105,9 @@ If you discover a potential security issue in this project we ask that you notif
### Code of conduct
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). See [CODE_OF_CONDUCT.md](doc/CODE_OF_CONDUCT.md) for more details.
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). See [CODE_OF_CONDUCT.md](https://github.com/awslabs/s3-connector-for-pytorch/blob/main/doc/CODE_OF_CONDUCT.md) for more details.
## License
Amazon S3 Connector for PyTorch has a BSD 3-Clause License, as found in the [LICENSE](LICENSE) file.
Amazon S3 Connector for PyTorch has a BSD 3-Clause License, as found in the [LICENSE](https://github.com/awslabs/s3-connector-for-pytorch/blob/main/LICENSE) file.

0 comments on commit e1d871e

Please sign in to comment.