-
Notifications
You must be signed in to change notification settings - Fork 141
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
Uniform documentation and example Notebooks for all transforms! #753
Comments
@shahrokhDaijavad can you please follow-up with the individual transform owners. |
@shahrokhDaijavad @agoyal26 Here is my suggestion on first batch of transforms to be updated. What do you guys think?
|
This is a good first batch, @Bytes-Explorer. The owners of these transforms are: Boris, Michele, Sung, Tsuzuku-san, and Yang Zhao. We can go ahead and assign them, but we need to discuss what (and a timeline) to expect if they are doing other projects at the moment. |
I believe you already have the template for documentation which should help all the owners fill in. Btw, Constantin has taken over all the work from Boris. |
@cmadam , @dolfim-ibm , @sungeunan-ibm , @dtsuzuku-ibm and @ian-cho We have started a significant effort to simplify the use of DPK for the first-time users. For the first step, we have a template for what we think should be in the README for each transform (attached). As the owners of the first batch of transforms (list below), I am going to assign to you the task of such documentation for your transform with a target date of Nov. 22. Please use your good judgment to do this, based on what the current README has and what the common template is trying to achieve. If current work commitments prevent you from doing this, please comment, and suggest a way forward (e.g., a later date, a different person to assign this task to, etc). Owners: |
Signed-off-by: Daiki Tsuzuku <[email protected]>
Hi, @cmadam, @dolfim-ibm, @sungeunan-ibm and @ian-cho . I just looked at the PR @dtsuzuku-ibm has submitted for the documentation of Doc_quality (PR #790) and if you haven't started doing this, you can use that README as a model (easier than the template above). |
BTW, we are working towards a template for the Jupyter notebook in this issue #754, and we will make it more solid in the next couple of days as a model to follow. |
@shahrokhDaijavad here we go #800 |
@dtsuzuku-ibm, @cmadam, @dolfim-ibm, @sungeunan-ibm and @ian-cho (cc: @agoyal26 and @touma-I): |
@shahrokhDaijavad Should we not keep all notebooks in the example folder? Readme can have the link. |
@Bytes-Explorer I think we should use the example folder for "use cases" that use a sequence of transforms to showcase that use case, e.g., RAG, fine-tuning, etc. IMHO, a single-function Notebook that only shows how to use the transform belongs to the directory of that transform, as it complements the README file of that transform with some real code. If you have a good reason for putting all these single-function notebooks in the examples folder, I change my opinion easily! |
Do I get it right, such a notebook will run only when the transform (in its latest state) is published to pypi? When changing the transform, we need to wait the (pre)release before we can update the notebook, right? |
@shahrokhDaijavad I see where you are coming from. I am coming from the point of view that if all examples are in the same folder like this one, it is easy for a beginner to have one place to look for things and get started. Application specific examples can be in sub folders, like this one and this one. |
@dolfim-ibm We could setup the venv environment for running the notebook based on either pip install or make venv. I have the feeling most developers will want to use |
@shahrokhDaijavad @Bytes-Explorer I would lean to keep this in the transform folder and not require the developer to make it work with collab. What we are asking here is very specific for the transform owner to think through how folks use their transform in a notebook and reduce as much as possible the number of variables that the developers need to deal with. |
Signed-off-by: Constantin M Adam <[email protected]>
Signed-off-by: Constantin M Adam <[email protected]>
Search before asking
Component
Other
Feature
This is a "super-issue" that will affect all transforms! Each transform owner will be assigned to do two tasks, for the transform they won:
Are you willing to submit a PR?
The text was updated successfully, but these errors were encountered: