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

Add update/reinstall & training documentation #788

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

mathieuboudreau
Copy link
Member

@mathieuboudreau mathieuboudreau commented Feb 16, 2024

Checklist

  • I've given this PR a concise, self-descriptive, and meaningful title
  • I've linked relevant issues in the PR body
  • I've applied the relevant labels to this PR
  • I've added relevant tests for my contribution
  • I've updated the documentation and/or added correct docstrings
  • I've assigned a reviewer
  • I've consulted ADS's internal developer documentation to ensure my contribution is in line with any relevant design decisions

Description

Our old update/reinstall instructions would occasionally lead to users having broken installs (see: #784), and so asking the users (note: not devs) to simply delete the repo and conda env and start over is likely the cleanest instructions we can provide.

I've also updated the Training section with two notices: one that IVADOMED is being discontinued, and another informing people that ADS is able to train models with their data (with conditions)

Linked issues

@mathieuboudreau mathieuboudreau added the documentation category: the change is documentation related to AxonDeepSeg label Feb 16, 2024
@mathieuboudreau
Copy link
Member Author

@coveralls
Copy link

coveralls commented Feb 16, 2024

Pull Request Test Coverage Report for Build 9194145887

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 88.982%

Totals Coverage Status
Change from base Build 8926146507: 0.0%
Covered Lines: 1163
Relevant Lines: 1307

💛 - Coveralls


From the parent folder of the AxonDeepSeg directory:::

rm -rf axondeepseg
Copy link
Member

Choose a reason for hiding this comment

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

For Windows users, the command will be rmdir axondeepseg

Copy link
Member Author

Choose a reason for hiding this comment

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

Is that on the powershell? Would the command be the same on the Anaconda terminal?

Copy link
Member

Choose a reason for hiding this comment

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

Would the command be the same on the Anaconda terminal?

Yes

@mathieuboudreau mathieuboudreau changed the title Add update/reinstall documentation Add update/reinstall & training documentation Apr 12, 2024

From the parent folder of the AxonDeepSeg directory:::

rm -rf axondeepseg
Copy link
Member

Choose a reason for hiding this comment

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

Here's the instruction box I suggest using

    # Mac and Linux
    rm -rf axondeepseg

    # Windows
    rmdir axondeepseg /s

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation category: the change is documentation related to AxonDeepSeg
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants