Skip to content

Commit

Permalink
Apply mdformat to optunahub-registry files other than packages.
Browse files Browse the repository at this point in the history
  • Loading branch information
y0z committed Jul 5, 2024
1 parent 19f2af3 commit dd5c6a5
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 24 deletions.
4 changes: 3 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

Please read the [contributor agreements](https://github.com/optuna/optunahub-registry/blob/main/CONTRIBUTING.md#contributor-agreements) and if you agree, please click the checkbox below.

- [ ] I agree to the contributor agreements.
- \[ \] I agree to the contributor agreements.

## Motivation

<!-- Describe your motivation why you will submit this PR. This is useful for reviewers to understand the context of PR. -->

## Description of the changes

<!-- Describe the changes in this PR. -->
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,15 @@ Finally, read [`contributor agreements`](#contributor-agreements) and if you agr

You can find tutorials to implement a package for the OptunaHub registry in [the OptunaHub registry documentation](https://optuna.github.io/optunahub-registry/).


## Contributor Agreements

1. By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I have the right to submit it under the MIT license indicated in the file:
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open-source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the MIT license, as indicated in the file; or
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
(a) The contribution was created in whole or in part by me and I have the right to submit it under the MIT license indicated in the file:
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open-source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the MIT license, as indicated in the file; or
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

2. By making a contribution to this project, I agree that the MIT license applies to the contribution and the contribution is used by Preferred Networks (“PFN”) or third party under the MIT license.
1. By making a contribution to this project, I agree that the MIT license applies to the contribution and the contribution is used by Preferred Networks (“PFN”) or third party under the MIT license.

3. I agree that PFN may remove my contribution from the Optuna Hub at any time, if the Contribution likely violates any of applicable law and regulation, or likely infringe or misappropriate any rights of any person or entity. I ALSO AGREE THAT PFN SHALL NOT BE RESPONSIBLE OR LIABLE FOR SUCH REMOVAL OF MY CONTRIBUTION.
1. I agree that PFN may remove my contribution from the Optuna Hub at any time, if the Contribution likely violates any of applicable law and regulation, or likely infringe or misappropriate any rights of any person or entity. I ALSO AGREE THAT PFN SHALL NOT BE RESPONSIBLE OR LIABLE FOR SUCH REMOVAL OF MY CONTRIBUTION.

4. I AGREE THAT PFN SHALL NOT BE RESPONSIBLE OR LIABLE FOR USE MODIFICATION OR REMOVAL OF MY CONTRIBUTION BY THIRD PARTY.
1. I AGREE THAT PFN SHALL NOT BE RESPONSIBLE OR LIABLE FOR USE MODIFICATION OR REMOVAL OF MY CONTRIBUTION BY THIRD PARTY.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@

OptunaHub Registry
==================
# OptunaHub Registry

OptunaHub Registry is a registry service for sharing and discovering user-defined Optuna packages. It provides a platform for users to share their Optuna packages with others and discover useful packages created by other users.

See the [OptunaHub Website](https://hub.optuna.org/) for registered packages.

See also the [OptunaHub API documentation](https://optuna.github.io/optunahub/) for the API to use the registry, and the [OptunaHub tutorial](https://optuna.github.io/optunahub-registry/) for how to register and discover packages.
See also the [OptunaHub API documentation](https://optuna.github.io/optunahub/) for the API to use the registry, and the [OptunaHub tutorial](https://optuna.github.io/optunahub-registry/) for how to register and discover packages.
31 changes: 19 additions & 12 deletions template/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
---
author: "Please fill in the author name here."
title: "Please fill in the title of the feature here."
description: "Please fill in the description of the feature here."
tags: ["Please fill in the list of tags here."]
optuna_versions: ["Please fill in the list of versions of Optuna in which you have confirmed the feature works, e.g., 3.6.1."]
license: "MIT License"
author: Please fill in the author name here.
title: Please fill in the title of the feature here.
description: Please fill in the description of the feature here.
tags: [Please fill in the list of tags here.]
optuna_versions: ['Please fill in the list of versions of Optuna in which you have confirmed the feature works, e.g., 3.6.1.']
license: MIT License
---

<!--
This is an example of the frontmatters.
All columns must be string.
You can omit quotes when value types are not ambiguous.
However, quotes are required in ambiguous cases, e.g., '3.5' must not be 3.5.
---
author: "Optuna team"
title: "My Sampler"
description: "A description for My Sampler."
tags: ["sampler", "2nd tag for My Sampler", "3rd tag for My Sampler"]
optuna_versions: ["3.5.0", "3.6.1"]
author: Optuna team
title: My Sampler
description: A description for My Sampler.
tags: [sampler, 2nd tag for My Sampler, 3rd tag for My Sampler]
optuna_versions: ['3.5', 3.6.1]
license: "MIT License"
---
-->
Expand All @@ -25,16 +28,20 @@ You can find more detailed explanation of the following contents in the tutorial
Looking at [other packages' implementations](https://github.com/optuna/optunahub-registry/tree/main/package) will also help you.

## Class or Function Names

Please fill in the class/function name which you implement here.

## Installation

If you have additional dependencies, please fill in the installation guide here.
If no additional dependencies is required, this section can be removed.

## Example

Please fill in the code snippet to use the implemented feature here.

## Others

Please fill in any other information if you have here by adding child sections (###).
If there is no additional information, this section can be removed.

Expand All @@ -54,4 +61,4 @@ Optuna: A Next-generation Hyperparameter Optimization Framework. In KDD.
year={2019}
}
```
-->
-->

0 comments on commit dd5c6a5

Please sign in to comment.