aeon-toolkit / aeon

A toolkit for machine learning from time series
https://aeon-toolkit.org/
BSD 3-Clause "New" or "Revised" License
1.01k stars 118 forks source link

Sweep: Update API page in docs/api_reference/ #772

Closed sweep-ai[bot] closed 1 year ago

sweep-ai[bot] commented 1 year ago

The file "aeon/distances/init.py" imports several functions from other files in the module, but the relevant API page in "docs/api_reference/distances.rst" is not up-to-date currently. Please update the API page to include the public functions and classes which are not present already on the page. Here are the distances measures that need to be added:

The documentation uses sphinx to build. Follow the format already used in the distance page when updating it. All subsections should be listed in alphabetical order, except for those beginning with "general" which should be at the bottom of the page. The functions within each subsection should also be in alphabetical order. Ensure there are no duplicate entries.

Checklist - [X] `docs/api_reference/distances.rst` ✅ Commit [`2544b13`](https://github.com/aeon-toolkit/aeon/commit/2544b131e5469f409ecb7716d637e42e77ee4c04)
sweep-ai[bot] commented 1 year ago

Here's the PR! https://github.com/aeon-toolkit/aeon/pull/776.

⚡ Sweep Free Trial: I'm creating this ticket using GPT-4. You have 3 GPT-4 tickets left for the month and 1 for the day. For more GPT-4 tickets, visit [our payment portal.](https://buy.stripe.com/6oE5npbGVbhC97afZ4)

Actions (click)


Step 1: 🔎 Searching

I found the following snippets in your repository. I will now analyze these snippets and come up with a plan.

Some code snippets I looked at (click to expand). If some file is missing from here, you can mention the path in the ticket description. https://github.com/aeon-toolkit/aeon/blob/934249c21de1480251711a9e374d46f652ae87fc/docs/api_reference/distances.rst#L1-L163

Step 2: ⌨️ Coding

pre-commit install 1/2 ✓
pre-commit installed at .git/hooks/pre-commit
pre-commit run --all-files 2/2 ✓
[INFO] Initializing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Initializing environment for https://github.com/pycqa/isort.
[INFO] Initializing environment for https://github.com/psf/black.
[INFO] Initializing environment for https://github.com/pycqa/flake8.
[INFO] Initializing environment for https://github.com/pycqa/flake8:flake8-bugbear,flake8-print.
[INFO] Initializing environment for https://github.com/mgedmin/check-manifest.
[INFO] Initializing environment for https://github.com/nbQA-dev/nbQA.
[INFO] Initializing environment for https://github.com/nbQA-dev/nbQA:black==22.3.0.
[INFO] Initializing environment for https://github.com/nbQA-dev/nbQA:isort==5.6.4.
[INFO] Initializing environment for https://github.com/nbQA-dev/nbQA:flake8==3.8.3.
[INFO] Initializing environment for https://github.com/pycqa/pydocstyle.
[INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pycqa/isort.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/psf/black.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pycqa/flake8.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/nbQA-dev/nbQA.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/nbQA-dev/nbQA.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/nbQA-dev/nbQA.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pycqa/pydocstyle.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
check for added large files..............................................Passed
check for case conflicts.................................................Passed
check for merge conflicts................................................Passed
check for broken symlinks................................................Passed
check yaml...............................................................Passed
debug statements (python)................................................Passed
fix end of files.........................................................Passed
fix python encoding pragma...............................................Passed
fix requirements.txt.................................(no files to check)Skipped
trim trailing whitespace.................................................Passed
isort....................................................................Passed
black....................................................................Passed
flake8...................................................................Passed
nbqa-black...............................................................Passed
nbqa-isort...............................................................Passed
nbqa-flake8..............................................................Passed
pydocstyle...............................................................Passed


Step 3: 🔁 Code Review

I have finished reviewing the code for completeness. I did not find errors for sweep/update-api-page.

.


🎉 Latest improvements to Sweep:


💡 To recreate the pull request edit the issue title or description. To tweak the pull request, leave a comment on the pull request. Join Our Discord