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

Help Write Notes on Data Science #68

Open
8 of 84 tasks
wyattowalsh opened this issue Jan 27, 2021 · 14 comments · Fixed by #64, #65, #66 or #70
Open
8 of 84 tasks

Help Write Notes on Data Science #68

wyattowalsh opened this issue Jan 27, 2021 · 14 comments · Fixed by #64, #65, #66 or #70
Labels
good first issue Good for newcomers help wanted Extra attention is needed index indexes issues up for grabs
Projects
Data Science Notes

Comments

@wyattowalsh
Copy link
Owner

wyattowalsh commented Jan 27, 2021 •
edited

Project Context

There are certainly many topics that are good for a data scientist to know and practice! I've tried my best so far to research and develop what I would consider an outline of the different topics broken up into the major sections of interest and practice. This is by no means a comprehensive list, but is ever developing and so far contains most topics. The goal with this is to present the reader with a solid index of the different topics with easily accessible content of the topic's context, overview, and more specific details.

In the Jupyter Book framework (and as specified in the _toc.yml project file) this strategy breaks down into parts, each containing chapters of which can single pages or collections of pages, where each page can be either a single page or collection of pages. [Read more about Jupyter Book structure here]

Completing the Basics

It would be wonderful to add helpful content to each topic's section (we can always refine the content over time).

Sources can be cited by adding a reference to the references.bib file associated to the topic and using the {cite} command as described in the Jupyter Book documentation. I recommend using BibMe service to build the correct citation to add to references.bib.

Furthermore, additional features can be utilized like multichoice panels, special content blocks, and syntax highlighting! Check out the Jupyter Book documentation for more info!

I'm totally happy to help in whatever form I can, just let me know how I may be of assistance!

Roadmap

Topics With Content

Topics In Progress

Full Topic Index

@wyattowalsh wyattowalsh added help wanted Extra attention is needed good first issue Good for newcomers up for grabs labels Jan 27, 2021
@wyattowalsh wyattowalsh added this to the Finish Basics Pages milestone Jan 27, 2021
@wyattowalsh wyattowalsh added this to To Do Eventually in Data Science Notes via automation Jan 27, 2021
@wyattowalsh wyattowalsh moved this from To Do Eventually to To Do Now in Data Science Notes Jan 27, 2021
@wyattowalsh wyattowalsh moved this from To Do Now to In Progress in Data Science Notes Jan 27, 2021
@wyattowalsh wyattowalsh pinned this issue Jan 27, 2021
@jtboing
Copy link

jtboing commented Jan 27, 2021 •
edited

Hello there, I have noticed this repository from the up-for-grabs.net website and I'd like to contribute here. But, first I have some questions regarding the written content:

  1. Do you have a general outline of the book, beside the headings? For example, what kind of structure do you have in mind for each chapter? Does this differ for each individual contributor?
  2. Is there an editor for all the content written? Or does each contributor self-edit their own work?
  3. Is there a way to list sources and citations?

@wyattowalsh
Copy link
Owner Author

Hey there @jtboing! Thanks for your comment, nice to see you here! 😊

These are great questions!

So far, I've been trying to build out the structure of the book and add guidelines for contributing, so these questions are right along the lines I've been considering (do lookout for when I update the issue with complete contribution guidelines).

In short:

  1. In general there are landing pages and basics pages so far (with more specific pages to come as folks add them, such as OLS and Regularized Forms).

    • Along these lines, I think Landing Pages [ Complete Landing Pages #67 ] are more of a general overview and introduction to a certain topic, which may require a different structure depending on the topic. Thus, they would be a good place for images, visualizations, and objects to attract readers and inspire them to read the section to follow.

    • Further, Basics pages I think should be less introductory and more technical; they should inform the reader of what specifics exist for a topic, how these specifics fit together/what use cases they are for, and brief information on basic usage. Similarly, these pages may require different structures to accomplish this goal, depending on the topic.

    • This way, readers are given a place to get excited about the material of a certain topic (landing pages) and get a technical overview of that topic (basics pages). After they have been given the proper context and introduction, they can then browse specific pages as interested.

  2. Currently, I am the only maintainer of the project, but admittedly am not an expert across all topics. I am happy to edit to the best of my capabilities but was hoping that content would be improved through readers raising issues as well as self-editing and listings sources/citations. Another way is through the pull request template by having contributors ensure if they have listed their sources or if not to put their LinkedIn Profile for qualification confirmation. If you have any ideas on this or would like to help edit, let me know!

  3. Yes, most definitely! There are actually a few ways of going about this:

    • So far I've been listing sources at the bottom of the page in an itemized list, but I would definitely like to improve on this format
    • The best format seems to be using local bibliographies and the cite command as described on the Jupyter Book page here
      • In this format, a .bib file would be created for each page and then cited accordingly for the page using the commands as described at the link.

Let me know your thoughts! Any ideas or perspective could prove helpful! I'm quite open-minded and just trying to make the most out of the project!

This was linked to pull requests Jan 27, 2021
Added info to word tokenizer #64
Merged
Added info to sentence tokenization, Stemming and Lemmatization #65
Merged
Added stop words #66
Merged
Added BagOfWords, Regex #70
Merged
@wyattowalsh wyattowalsh changed the title Complete Basics Pages Add Basic Content to Topics Jan 28, 2021
@wyattowalsh wyattowalsh removed this from the Finish Basics Pages milestone Jan 28, 2021
@wyattowalsh
Copy link
Owner Author

I've been able to make a few changes to the overall structure as well as have added citation/reference functionality through the addition of references.bib files and basic layout (including bibliography code) for all pages.

I also updated the main issue comment to reflect these changes and integrate feedback

@wyattowalsh wyattowalsh mentioned this issue Jan 28, 2021
Closed
53 tasks
@wyattowalsh wyattowalsh changed the title Add Basic Content to Topics Help Write Notes on Data Science Jan 29, 2021
@wyattowalsh wyattowalsh added good first issue Good for newcomers help wanted Extra attention is needed up for grabs index indexes issues and removed good first issue Good for newcomers help wanted Extra attention is needed up for grabs labels Jan 29, 2021
@jtboing
Copy link

jtboing commented Jan 30, 2021

Thank you for the answers, I think adding some of what you wrote in the contributing docs might be a good idea. It will remind a contributor to be aware of the structure of the book and the importance of citations. I think in this phase of the project relying more on self-editing would suffice. I would also be inclined to help edit as well if necessary.

I can start by writing about Tensorflow and version control. I think adding Subversion to the list of version controls is needed, though I haven't used Subversion myself.

@wyattowalsh
Copy link
Owner Author

Hey @jtboing, sorry for the late reply!

That sounds good to me; I updated things accordingly! For the version control, I simplified the layout and just made the pages for Git, GitHub, GitLab, and Subversion as sections of the version control page.

It would be wonderful to see your contributions for Tensorflow/version control. Let me know if you need any help!

@altela
Copy link

altela commented Mar 26, 2021

Hi @wyattowalsh , i saw this project in up-for-grabs.net and i would like to help. Maybe i could write something like Postgresql, but, should i also write the content too or just the section on the left?

@KazushiR
Copy link

KazushiR commented Oct 7, 2021

Hi @wyattowalsh. I saw this project up for grabs and would like to help out. Is there any basic issues that can be resolved?

@Suchitgeek
Copy link

Suchitgeek commented Aug 9, 2022 •
edited

@wyattowalsh Hi, I saw the topic and I'm very interested in contributing to writing notes on data science. Is there any space needed? Please let me know I'm very excited to contribute to open source.

@chandu-jadhav
Copy link

Hi, I saw the topic and I'm very interested in contributing to writing notes on data science. Is there any space needed? Please let me know I'm very excited to contribute to open source.

@Iamchandra-3
Copy link

Hi @wyattowalsh , I saw your project on up-for-grabs.net and I would love to help out! I'm really interested in writing notes on data science, so I was wondering if there was any space for me to contribute? Let me know, I'm excited to help out with open source projects!

@KayO-GH
Copy link

KayO-GH commented Oct 10, 2022

Hi there, @wyattowalsh
Still looking for help on this? I'd like to contribute

@yoursmanjunad
Copy link

Hey @wyattowalsh, nice to meet you here! I would love to contribute my service to this project. I'm super excited to help you out

@ankit0806
Copy link

Hi there !!, I would like to contribute to this project if it is still open

@akshayamadhuri
Copy link

@wyattowalsh i would like to contribute can you assign me

@shravan562
Copy link

het, i would like to contribute in this if needed any help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers help wanted Extra attention is needed index indexes issues up for grabs
Projects
Data Science Notes
  
In Progress
Milestone
No milestone