Skip to content

Improve documentation with missing info and better readability #133

Description

@MarleneKress79789
### Tasks
- [x] overhaul documentation for better readability
- [x] do we want to use pyexasol for the connection in the user guide? looks cleaner imo
- [x] also info about adding SSL certificate?
- [x] mention each model is 2 part model and transformer (in dev guide at least)
- [ ] in dev docu: add info about change of model if parameters changed(happens in base_model_udf), and how
- [ ] in user docu: mention udf can change udf/model if the input set changes the model parameters
- [ ] add example usages in user docu (will be done in #164)
- [x] mention trigger slc dowload test after release to make sure it works with new version. test_language_container_deployer_cli_by_downloading_container (maybe trigger automatically in nox session which does a release)
- [x] add information about the certificates as explained [here](https://github.com/exasol/transformers-extension/pull/150/files/99549de939e855f1698a05a4145d3373f51ffab9#r1392322048 )
- [x] add explanation about model download and uplaod, details [here](https://github.com/exasol/transformers-extension/pull/150#discussion_r1392443311)
- [x] mention after release check .dist and .dist in language container for multiple wheels
- [x] mention windows not supported
- [x] change description of project to mention Huggingface
- [x] see comments in https://github.com/exasol/transformers-extension/pull/150
- [x] link to udf docu
- [x] link to bucketfs docu
- [ ] add screenshot from exa operations where to find parameters like bucketfs name (see screenshot) #164
- [x] mention pypi release and pip install
- [x] get correct link  to pypi and install comand

Metadata

Metadata

Labels

documentationUser guides, tutorials, specifications

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions