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.

Sign up for GitHub

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

Jump to bottom

[Install] update the installation docs recomending the python -m rubrix.server way #994

Closed
dcfidalgo opened this issue Jan 18, 2022 · 3 comments · Fixed by #1040
Closed

[Install] update the installation docs recomending the python -m rubrix.server way #994

dcfidalgo opened this issue Jan 18, 2022 · 3 comments · Fixed by #1040
Assignees
@dcfidalgo
Labels
type: documentation Improvements or additions to documentation

Comments

@dcfidalgo
Copy link
Contributor

dcfidalgo commented Jan 18, 2022 •
edited
Loading

The idea is following default installation:

# install server dependencies
pip install rubrix[server]

# if no ES running
docker run ...

# run web app
python -m rubrix.server

advantage:

  • without docker-compose: easier to update the rubrix version
  • with ES container running in the background, easier to avoid data loss
  • we advocate only one way to start the web app, docker-compose is an extra that can still be used by "experts"

disadvantage:

  • we include the server dependencies in the default installation, installation is not as lightweight as before

note:

  • in the conda package we need to update the dependencies
@dcfidalgo dcfidalgo self-assigned this Jan 18, 2022
@dcfidalgo
Copy link
Contributor Author

@frascuchon @dvsrepo

@dcfidalgo dcfidalgo added the type: documentation Improvements or additions to documentation label Jan 18, 2022
@dvsrepo
Copy link
Member

dvsrepo commented Jan 18, 2022

I like it a lot this way. Also, it's a good opportunity to have a very clear documentation for installation section

@frascuchon
Copy link
Member

We can include also the basics of howto launch with uvicorn directly

frascuchon added a commit that referenced this issue Jan 24, 2022
@frascuchon
chore(#994): simplify server start (#1014)
7667ae8 
* refactor: move server launch to main module

* docs: update setup section

* revert: remove old __main__ file

* chore: include FutureWarning

* Update docs/getting_started/setup&installation.rst

Co-authored-by: David Fidalgo <david@recogn.ai>

Co-authored-by: David Fidalgo <david@recogn.ai>
dvsrepo added a commit that referenced this issue Jan 25, 2022
@dvsrepo
Merge branch 'master' of https://github.com/recognai/rubrix
8f89dda 
* 'master' of https://github.com/recognai/rubrix: (28 commits)
  chore(#994): simplify server start (#1014)
  refactor(#945): elasticsearch index configuration per task (#1018)
  docs(#980): Add majorityvote example to weak supervision guide (#1004)
  fix(#1015): manage emojis in Token Classification records (#1016)
  fix(#1010): fix WeakLabels when not providing rules (#1011)
  fix(Breadcrumbs): Copy text function (#1003)
  fix(statics): handle 404 errors for static files (#1006)
  refactor: Rename 'exclude_missing_annotation' argument for WeakLabels.annotation (#1005)
  docs: update video for spacy ner tutorial (#1000)
  fix(#977) Remove redirection when accessing login (#996)
  feat(#951): new uncovered_by_rules records filter (#991)
  feat(#735): add warning when agent but no prediction/annotation is provided (#987)
  fix(#800): limit number of metadata fields (#993)
  docs: improve annotate records section in web app reference (#985)
  fix(#844) Keep header layout when errors occurred in dataset view (#992)
  fix(#974): display the dropdown in the last record of the scroll (#986)
  refactor: compute common aggregations one by one (#990)
  feat(#953): add additional metrics to `LabelModel.score` method (#979)
  refactor(rules): using labeling rules management with vuex store (#878)
  feat(#955): add default for `rules` in WeakLabels (#976)
  ...
@dcfidalgo dcfidalgo mentioned this issue Jan 26, 2022
Merged
dcfidalgo pushed a commit that referenced this issue Jan 27, 2022
@frascuchon
docs(#994): Change setup guide to recommend using python to start the…
c3ffe14 
… server (#1040)

* docs: improve setup guide

* docs: update quick start

* docs: few fixes

* docs: fix quotation

* Update docs/getting_started/advanced_setup_guides.rst

Co-authored-by: Francisco Aranda <frascuchon@gmail.com>

* Update docs/index.rst

Co-authored-by: Francisco Aranda <frascuchon@gmail.com>

* docs: improve es with docker section

* docs: fix code formating in code blocks

* docs: update readme

* docs: small fixes, improvements

* docs: update readme

Co-authored-by: Francisco Aranda <frascuchon@gmail.com>
frascuchon added a commit that referenced this issue Feb 2, 2022
@frascuchon
chore(#994): simplify server start (#1014)
504c3f6 
* refactor: move server launch to main module

* docs: update setup section

* revert: remove old __main__ file

* chore: include FutureWarning

* Update docs/getting_started/setup&installation.rst

Co-authored-by: David Fidalgo <david@recogn.ai>

Co-authored-by: David Fidalgo <david@recogn.ai>
(cherry picked from commit 7667ae8)
frascuchon pushed a commit that referenced this issue Feb 2, 2022
docs(#994): change setup guide to recommend using python to start the…
6287400 
… server (#1040)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dcfidalgo dcfidalgo

Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(#994): Change setup guide to recommend using python to start the server argilla-io/argilla
3 participants
@dvsrepo @frascuchon @dcfidalgo