1.0.5 - automatic version checking enabled

VERSION

@@ -1 +1 @@
-1.0.1
+1.0.5

basedai.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: basedai
-Version: 1.0.1
+Version: 1.0.5
 Summary: basedai
 Home-page: https://github.com/basedproto/basedai
 Author: getbased.ai
@@ -20,6 +20,8 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
 Classifier: Topic :: Scientific/Engineering :: Visualization
 Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
+Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -28,4 +30,104 @@ Description-Content-Type: text/markdown
 Provides-Extra: dev
 License-File: LICENSE
 
-#  
+<div align="center">
+
+# **BasedAI** 
+[![Research](https://img.shields.io/badge/arXiv-2403.01008v1-red.svg)](https://arxiv.org/abs/2403.01008)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) 
+---
+[Documentation](https://docs.getbased.ai/) • [Token](https://app.uniswap.org/explore/tokens/ethereum/0x44971abf0251958492fee97da3e5c5ada88b9185) • [Twitter](https://twitter.com/getbasedai)
+
+</div>
+
+BasedAI is a decentralized network built to enable end-to-end private computations on distributed GPU infrastructure. The flagship 'Brain' of BasedAI is allows for Fully Homomorphic Encryption (FHE) of Large Language Models (LLMs), effectively creating Zero-Knowledge LLMs (ZK-LLMs).
+
+For detailed understanding of the BasedAI network and its groundbreaking approach with ZK-LLMs, please refer to our [research paper](https://arxiv.org/abs/2403.01008).
+
+# Install
+
+1. To get started with BasedAI:
+
+```bash
+# pip install basedai
+```
+
+# Getting Started 
+
+In the BasedAI ecosystem, users participate through an integrated wallet system that supports operations with BasedAI's native token, $BASED. The wallet enables users to stake tokens on different Brains in the ecosystem and earn rewards for contributions.
+
+To get started with managing wallets and tokens:
+
+1. Create a new wallet through the BasedAI CLI:
+```bash
+# create a wallet  
+basedcli wallet new_personalkey
+```
+
+2. Interact with your wallet via the BasedAI CLI. 
+```bash
+# check the balances of your wallet 
+basedcli wallet balance
+```
+3. Join as a Brain miner or validators with a compute key: 
+```bash
+# check the balances of your wallet 
+basedcli wallet new_personalkey
+```
+
+4. Get some test $BASED
+```bash
+# minimal mining of test $BASED 
+basedcli wallet faucet
+```
+
+```bash
+# create a new compute wallet for agents operating on your behalf in the network
+basedcli wallet new_computekey
+```
+
+2. Interact with your wallet via the BasedAI CLI. 
+```bash
+# check the balances of your wallet 
+basedcli wallet balance
+```
+
+For further instructions on token management and participation in the network, please refer to the [official documentation](https://docs.getbased.ai/).
+
+## Using the CLI
+
+The BasedAI Command Line Interface (CLI) will be the primary tool for interacting with Brains, managing wallets, participating in computation tasks as miners or validators, and engaging in the token economy of BasedAI.
+
+For a list of possible commands:
+```bash
+basedcli help
+```
+
+## The BasedAI PIP Package
+
+The BasedAI package includes essential tools included `basedai` (the Python operations package for developers) and `basedcli` (for setting up mining, validation activities, and querying ZK-LLMs). Learn more in the [official documentation](https://docs.getbased.ai). 
+
+## Governance and Voting
+
+BasedAI embraces decentralized decision-making through Pepecoin-linked "Brains". Owners of GigaBrains, representing significant staked contributions, can participate in voting on key network decisions, upholding the ecosystem's democratic governance model.
+
+For voting procedures:
+```bash
+# vote for a proposal
+basedcli brains vote <proposal-id> <option>
+```
+
+## For More Information 
+
+For further information and updates on BasedAI, please visit the [official website](https://getbased.ai) or consult the initial [research paper](https://getbased.ai/whitepaper). 
+
+## License
+The MIT License (MIT)
+Copyright © 2024 Based Labs 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

basedai/__init__.py

@@ -25,7 +25,7 @@
 nest_asyncio.apply()
 
 # BasedAI code and protocol version.
-__version__ = "1.0.1"
+__version__ = "1.0.5"
 
 version_split = __version__.split(".")
 __version_as_int__ = (

basedai/cli.py

@@ -239,7 +239,7 @@ def __init__(
         cli.check_config(self.config)
 
         # If no_version_checking is not set or set as False in the config, version checking is done.
-        if not self.config.get("no_version_checking", d=True):
+        if not self.config.get("no_version_checking", d=False):
             try:
                 basedai.utils.version_checking()
             except:

basedai/extrinsics/registration.py

@@ -32,7 +32,7 @@ def register_extrinsic(
     wait_for_inclusion: bool = False,
     wait_for_finalization: bool = True,
     prompt: bool = False,
-    max_allowed_attempts: int = 3,
+    max_allowed_attempts: int = 5,
     output_in_place: bool = True,
     cuda: bool = False,
     dev_id: Union[List[int], int] = 0,
@@ -466,7 +466,7 @@ def run_faucet_extrinsic(
         except MaxSuccessException:
             return True, f"Max successes reached: {3}"
 
-        except MaxAttemptedException:
+        except MaxAttemptsException:
             return False, f"Max attempts reached: {max_allowed_attempts}"
 
 

basedai/utils/__init__.py

@@ -77,7 +77,7 @@ def version_checking(timeout: int = 15):
 
         if latest_version_as_int > basedai.__version_as_int__:
             print(
-                "\u001b[33mBasedai Version: Current {}/Latest {}\nPlease update to the latest version at your earliest convenience. "
+                "\u001b[33mBasedAI Version: Current {}/Latest {}\nPlease update to the latest version at your earliest convenience. "
                 "Run the following command to upgrade:\n\n\u001b[0mpython -m pip install --upgrade basedai".format(
                     basedai.__version__, latest_version
                 )

setup.py

@@ -95,7 +95,6 @@ def read_requirements(path):
         "Topic :: Scientific/Engineering :: Bio-Informatics",
         "Topic :: Scientific/Engineering :: Medical Science Apps.",
         "Topic :: Scientific/Engineering :: Physics",
-        "Topic :: Scientific/Engineering :: Machine Learning",
         "Topic :: Software Development",
         "Topic :: Software Development :: Libraries",
         "Topic :: Software Development :: Libraries :: Python Modules",