Skip to content

README updates for SDK#2309

Merged
basfroman merged 5 commits intobtsdkfrom
rajk/revise-README
Sep 18, 2024
Merged

README updates for SDK#2309
basfroman merged 5 commits intobtsdkfrom
rajk/revise-README

Conversation

@rajkaramchedu
Copy link

Welcome!

Due to GitHub limitations,
please switch to Preview for links to render properly.

Please choose the right template for your pull request:

Changing the README doc.

@rajkaramchedu
Copy link
Author

In the Release Guidelines doc there are references to scripts that are absent. We should remember to fix that in a next PR.

README.md Outdated
Comment on lines +89 to +92
### Install using `pip3 install`

```bash
btcli --print-completion bash >> ~/.bashrc # For Bash
btcli --print-completion zsh >> ~/.zshrc # For Zsh
source ~/.bashrc # Reload Bash configuration to take effect
pip3 install bittensor
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest pushing the user to install bittensor in the local python environment created for this purpose.
Kind of

python3 -m venv venv
source venv/bin/activate
pip install bittensor

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used "myenv" for my environment name, just to avoid confusion between "venv" command option.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't mind. I just want to add that python -m venv venv is something like a standard in this process that I have encountered most along the way.
But if we want to use the name other than the default one, I would prefer to use something more explicit. For example: python3 -m venv bt_venv or python3 -m venv bittensor_venv.
But again, it's up to you.

README.md Outdated
You can verify your installation in either of the two ways as shown below:

The Bittensor Subnets API consists of abstract classes and a registry system to dynamically handle API interactions. It allows developers to implement custom logic for storing and retrieving data, while also providing a straightforward way for end users to interact with these functionalities.
### Verify using the `btcli` command
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default SDK installation does not include btcli. To install btcli user need to run the command:

pip install bittensor[btcli]

Even in this case, the command btcli --help will show the btcli version, but not bittensor sdk.
To check the btsdk version, user need to run the command:

python -m bittensor

This can be mentioned below in the step Verify using Python interpreter or/and Verify the installation.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The community has mentioned many times that they don't want to install a lot of unnecessary dependencies for certain tasks.
I would like to see a section of the documentation where we explicitly highlight this change.

Currently, the user can install the bittensor with several options:

  • pip install bittensor - only SDK bittensor;
  • pip install bittensor[btcli] - SDK bittensor with btcli (btcli will be installed as an independent tool. Python package name is bittensor-cli);
  • pip install bittensor[torch] - Torch package will be installed too;
  • pip install bittensor[cubit] - Cubit package will be installed too.

Copy link
Collaborator

@basfroman basfroman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for me.

Co-authored-by: garrett-opentensor <156717492+garrett-opentensor@users.noreply.github.com>
Co-authored-by: garrett-opentensor <156717492+garrett-opentensor@users.noreply.github.com>
@basfroman basfroman merged commit 55dd03d into btsdk Sep 18, 2024
@basfroman basfroman deleted the rajk/revise-README branch September 18, 2024 16:01
@ibraheem-abe ibraheem-abe mentioned this pull request Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants