Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create new examples for distances appearing in v0.4.1 #27

Open
cobycloud opened this issue Aug 20, 2024 · 1 comment
Open

Create new examples for distances appearing in v0.4.1 #27

cobycloud opened this issue Aug 20, 2024 · 1 comment

Comments

@cobycloud
Copy link
Contributor

cobycloud commented Aug 20, 2024

Overview:

If a distance in the swarmauri/standard/distances/concrete does not have a notebook in the distances folder, then create one.


Distances

Any distance file missing a distances example.

@cobycloud cobycloud added this to the v0.4.1 milestone Aug 20, 2024
@cobycloud
Copy link
Contributor Author

Steps

  1. Create new notebook in the distances folder

  2. Go to test file in Swarmauri SDK

  3. Using the python class' test file, create an instructional jupyter notebook file.

    • Separate sections of the code and add markdown cells with instructional comments for Headers.
    • Provide additional comment under headers (in markdown) where necessary.
    • These notebooks will be used to teach other developers how to use the SDK, the comments should be phrased so that other developers can understand the code better.

For example:

  1. After you've created a new jupyter notebook file, make sure to clear the cell outputs and rerun the notebook all the way through so that the notebook is fully validated.

  2. Once you have a clean run of the jupyter notebook, commit the notebook changes to the swarmauri-notebook fork that you created.

  3. Every five jupyter notebooks, please submit a pull request from your fork to the main repository, these will serve as checkpoints.

  4. At the end of the day, create a final pull request from your fork to main repository.

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

No branches or pull requests

1 participant