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

docs: add dataframe documentation #576

Merged
merged 10 commits into from
Apr 3, 2024
Merged

Conversation

andrei-stoian-zama
Copy link
Collaborator

No description provided.

@andrei-stoian-zama andrei-stoian-zama requested a review from a team as a code owner April 2, 2024 14:03
@cla-bot cla-bot bot added the cla-signed label Apr 2, 2024
@jfrery
Copy link
Collaborator

jfrery commented Apr 3, 2024

Should we move the Pandas section? It feels a bit confusing next to Encrypted Dataframe

Copy link
Collaborator

@RomanBredehoft RomanBredehoft left a comment

Choose a reason for hiding this comment

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

several comments, some of which require some updates in the doc !

also, what happened to SUMMARY.md ?

finally, don't worry about the apidocs, they are generated automatically when we start the release process

Copy link
Collaborator

@jfrery jfrery left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thanks

@andrei-stoian-zama andrei-stoian-zama merged commit d3bf5ac into main Apr 3, 2024
12 checks passed
@andrei-stoian-zama andrei-stoian-zama deleted the docs/add_dataframe_docs_2 branch April 3, 2024 10:00
- [concrete.ml.torch.hybrid_model.md](references/api/concrete.ml.torch.hybrid_model.md)
- [concrete.ml.torch.md](references/api/concrete.ml.torch.md)
- [concrete.ml.torch.numpy_module.md](references/api/concrete.ml.torch.numpy_module.md)
- [concrete.ml.version.md](references/api/concrete.ml.version.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Copy link
Collaborator

Choose a reason for hiding this comment

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

answered by andrei here : #576 (comment)

Copy link
Collaborator

Choose a reason for hiding this comment

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

hum, is it compatible with what we have for Concrete gitbook and is it what was agreed with Yuxi?
by the way, if we remove that, pretty sure we can remove corresponding .sh

Copy link
Collaborator

@RomanBredehoft RomanBredehoft Apr 8, 2024

Choose a reason for hiding this comment

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

yes it is , basically the API was refered twice in the summary, now it's only available in :

## References

- [API](references/api/README.md)

which is what Yuxi added

I'm not sure what you mean by "the corresponding .sh" but isn't it what I did in #580 ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

  • ok I need to check it's done equivalently on Concrete side, then; it was done differently before I went to vacation, at least
  • ah yes indeed, ./script/doc_utils/update_apidocs_files_in_SUMMARY.sh was removed, perfect

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants