Rework readme - Githubissues

taoshidev / time-series-prediction-subnet

Prediction subnet built on Bittensor

https://taoshi.io

MIT License

57 stars 21 forks source link

Rework readme #28

Closed TaoshiKen closed 7 months ago

TaoshiKen commented 7 months ago

Taoshi Pull Request

Description

This update to the readme includes:

Links to important documents
Descriptions on what TSPS and Bittensor is
Better installation instructions for local, testnet, and mainnet environments
Contributing guide

Related Issues (JIRA)

Checklist

[ ] I have tested my changes on testnet.
[x] I have updated any necessary documentation.
[ ] I have added unit tests for my changes (if applicable).
[ ] If there are breaking changes for validators, I have (or will) notify the community in Discord of the release.

Reviewer Instructions

Check for typos and any unclear instructions

Definition of Done

[ ] Code has been reviewed.
[ ] All checks and tests pass.
[x] Documentation is up to date.
[ ] Approved by at least one reviewer.

Checklist (for the reviewer)

[ ] Code follows project conventions.
[x] Code is well-documented.
[ ] Changes are necessary and align with the project's goals.
[ ] No breaking changes introduced.

Optional: Deploy Notes

[Any instructions or notes related to deployment, if applicable.]

taoshidev1 commented 7 months ago

do we have a reference to HF anywhere for miners to get access to our models? https://huggingface.co/Taoshi/model_v4

feel this is a good idea.