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

Update README.md #818

Closed
wants to merge 1 commit into from
Closed

Conversation

joshuakraftaa
Copy link
Collaborator

  • Moved endpoint configuration down to the tutorials
  • Simplified the description of poetry installation

Description

No description.

Before Merging

  • Review the code changes
    • Unused print / comments / TODOs
    • Missing docstrings for functions that should have them
    • Consistent variable names
    • ...
  • Update changelog.md if necessary
  • Commit messages should contain a semantic label and the ticket number
    • Consider squashing if this is not the case

* Moved endpoint configuration down to the tutorials
* Simplified the description of poetry installation
Copy link
Collaborator

@MerlinKallenbornAA MerlinKallenbornAA left a comment

Choose a reason for hiding this comment

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

I just see some minor changes that should be done. Apart from that it looks good.

---
After correctly setting up the environment variables you can run the jupyter notebooks.
For this, run `jupyter lab` inside the virtual environment and go to the [examples](http://localhost:8888/lab/workspaces/auto-C/tree/src/documentation) directory.
The Intelligence Layer uses `poetry`, which serves as the package manager and manages the virtual environments. We recommend installing peotry globally, while still isolating it in a virtual environment, using pipx, following the [official instructions](https://python-poetry.org/docs/#installation).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The Intelligence Layer uses `poetry`, which serves as the package manager and manages the virtual environments. We recommend installing peotry globally, while still isolating it in a virtual environment, using pipx, following the [official instructions](https://python-poetry.org/docs/#installation).
We recommend installing peotry globally -> We recommend installing poetry globally

Copy link
Collaborator

Choose a reason for hiding this comment

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

I only wanted to point out the spelling error in poetry :)


---
After correctly setting up the environment variables you can run the jupyter notebooks.
For this, run `jupyter lab` inside the virtual environment and go to the [examples](http://localhost:8888/lab/workspaces/auto-C/tree/src/documentation) directory.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This one and the line above are now missing in your section. For people that don't have an integration in their IDE and are completely new to jupyter notebooks, this information is quite helpful.

So please add these lines :)

@SebastianNiehusAA
Copy link
Contributor

Closing an re-opening this PR to test CI trigger

@SebastianNiehusAA
Copy link
Contributor

Closing this PR in favor of #866 because it became easier to merge this way. Contributions will be mentioned accordingly.

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