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

[GSK-2879][GSK-3300] Technical documentation of Giskard Evaluator in the Giskard doc #1848

Conversation

Inokinoki
Copy link
Member

@Inokinoki Inokinoki commented Mar 14, 2024

Description

@cy-moi has created a full tutorial from the technical aspect. Move it to our doc and polish it.

Related Issue

Type of Change

  • 📚 Examples / docs / tutorials / dependencies update
  • 🔧 Bug fix (non-breaking change which fixes an issue)
  • 🥂 Improvement (non-breaking change which improves an existing feature)
  • 🚀 New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🔐 Security fix

Checklist

  • I've read the CODE_OF_CONDUCT.md document.
  • I've read the CONTRIBUTING.md guide.
  • I've updated the code style using make codestyle.
  • I've written tests for all new methods and classes that I created.
  • I've written the docstring in Google format for all the methods and classes that I used.

Copy link

linear bot commented Mar 14, 2024

Co-authored-by: zcy <congyao119@gmail.com>
@Inokinoki Inokinoki force-pushed the doc/gsk-2879-technical-documentation-in-the-giskard-documentation branch from 11ef63f to b8bba20 Compare March 14, 2024 16:26
@Inokinoki Inokinoki marked this pull request as ready for review March 14, 2024 17:44
@Inokinoki Inokinoki changed the title [GSK-2879] Technical documentation of Giskard Evaluator in the Giskard doc [GSK-2879][GSK-3300] Technical documentation of Giskard Evaluator in the Giskard doc Mar 15, 2024
Copy link

linear bot commented Mar 15, 2024

Copy link
Member

@luca-martial luca-martial left a comment

Choose a reason for hiding this comment

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

@Inokinoki can you please make the main HuggingFace integration page on its own with 2 cards inside, and 2 sub pages like this:
image
CleanShot 2024-03-21 at 17 54 51@2x

Then ill make the changes on the content

@Inokinoki
Copy link
Member Author

Inokinoki commented Mar 22, 2024

@Inokinoki can you please make the main HuggingFace integration page on its own with 2 cards inside, and 2 sub pages like this: image CleanShot 2024-03-21 at 17 54 51@2x

Then ill make the changes on the content

Thanks!
I updated it to like

image

because ToC does not want to include index.md.

@cy-moi
Copy link
Contributor

cy-moi commented Mar 22, 2024

🎉🎉🎉🎉

@luca-martial luca-martial requested review from Sakayatsp and removed request for rabah-khalek and luca-martial March 28, 2024 17:55
Copy link
Member

@luca-martial luca-martial left a comment

Choose a reason for hiding this comment

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

@Sakayatsp will take over the review

Correction of typos and reformulation of some sentences. I would add one more picture to show where the community tab is.
:::{warn} parts are not formatted properly
Copy link
Contributor

@Sakayatsp Sakayatsp left a comment

Choose a reason for hiding this comment

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

Once your job has finished, you will be able to find the scan report in the model’s community discussion page.

Maybe we could add a picture of the tabs to show where the community discussion page is.

Copy link
Contributor

Choose a reason for hiding this comment

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

The dataset preview doesn't look very professional, but it's a twitter dataset so maybe that's fine.

@luca-martial
Copy link
Member

Once your job has finished, you will be able to find the scan report in the model’s community discussion page.

Maybe we could add a picture of the tabs to show where the community discussion page is.

Yes good idea for a future improvement, lets merge this for now

Copy link

sonarcloud bot commented Apr 8, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@luca-martial luca-martial merged commit 67dfec4 into main Apr 8, 2024
16 checks passed
@luca-martial luca-martial deleted the doc/gsk-2879-technical-documentation-in-the-giskard-documentation branch April 8, 2024 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants